including proposals from batch 1

Summary

• Page properties (1 modified, 0 added, 0 removed)
• Attachments (0 modified, 2 added, 0 removed)
  • DocumentationXClass.png
  • DocumentationXClassExample.png

Details

Page properties

Content

...	...	@@ -43,6 +43,28 @@
43	43
44	44	That's all!
45	45
	46	+= Diataxis =
	47	+
	48	+Documentation on [[xwiki.org>>https://www.xwiki.org/xwiki/bin/view/Main/WebHome]] must follow the [[Diataxis>>https://diataxis.fr/]] methodology, which is a way of organizing the documentation.
	49	+In Diataxis, all documentation Pages are of one of 4 types:
	50	+
	51	+* Tutorials - learning-oriented experiences
	52	+* How-to guides - goal-oriented directions
	53	+* Reference - information-oriented technical description
	54	+* Explanation - understanding-oriented discussion
	55	+
	56	+In addition, documentation Pages are segmented into three target audiences to make it easier for readers to find relevant content based on their usage profile:
	57	+
	58	+* User
	59	+* Administrator
	60	+* Developer
	61	+
	62	+In order to apply Diataxis, split documentation Pages by type, and target. This is done by adding an ##xobject## of the [[##Documentation XClass##>>XWikiOrg.DocumentationClass]] to each documentation Page.
	63	+
	64	+Below is an example of a documentation Page where the ##xproperties## have been set using the ##XWikiOrg.DocumentationClass:##
	65	+
	66	+{{image reference="DocumentationXClassExample.png" size="large"/}}
	67	+
46	46	= Updating existing pages =
47	47
48	48	Any documentation can become obsolete or just not be good enough from your point of view. In these cases, if you want to upgrade/improve the documentation, you shouldn't make changes directly in the documentation page. Rewriting the documentation can take very long and nobody wants to have unbaked bread. Please proceed as follows:

DocumentationXClass.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+xwiki:XWiki.elenicojocariu

Size

...	...	@@ -1,0 +1,1 @@
	1	+53.2 KB

Content

DocumentationXClassExample.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+xwiki:XWiki.elenicojocariu

Size

...	...	@@ -1,0 +1,1 @@
	1	+53.2 KB

Content