-
Notifications
You must be signed in to change notification settings - Fork 30
Wiki Conventions
Note: This is still a proposal. The author of this article thought that the proposed way is a good way to organise the Wiki content for consistency and readability.
Please give some feedback on this proposal: Twitter @hiwyed
##Structure of a guide
A guide page should follow the following structure, which is already in use on some Wiki pages:
The first segment of the page should be an "Abstract", which is a basic introduction to the guide.
All segment headers should be written in Markdown ##, which is the second Heading level.
All other guide content should be organized in about 2 - 4 other segments, whose headings are also formatted with Markdown ##.
On the bottom of each guide page there should be a further reading segment.
It should have the heading ##Further reading and contain a Markdown * unordered list with links to pages that are likely to be relevant to the reader.
##Structure of the Wiki home page The wiki home page should contain a basic overview of important topics covered in the Wiki. The upper part of this page should be especially oriented towards new developers to give them an easy start.
Wiki page links are organised into categories like "Your first Plugin" or "Disa concepts". Each link is accompanied by 1 or 2 lines of description about the linked page.
Below all this there must be a skill level (formatted in italics) which represents the complexity of the content. There are the following skill levels to choose from:
- BEGINNER LEVEL - Understandable for absolute beginners to the Disa framework, but not for beginners to programming
- INTERMEDIATE LEVEL - Comprehensible for developers who have spent some time looking into the Disa framework
- PRO LEVEL - Written for very experienced Disa developers, otherwise too complicated
- ANY LEVEL - Understandable for everyone, even non-developers
© The Disa Open Source Project
If you have any questions please contact opensource@disa.im!

