Category:Concept: Difference between revisions
From Artisans Asylum Wiki
Acharlwood (talk | contribs) (Concept category) |
Acharlwood (talk | contribs) mNo edit summary |
||
| Line 6: | Line 6: | ||
===Writing a concept document=== | ===Writing a concept document=== | ||
Follow these best practices when writing reference documentation: | Follow these best practices when writing reference documentation: | ||
*Do not mix document types. Break out tasks or | *Do not mix document types. Break out tasks or references into their own wiki article. | ||
*Follow the [[style guide]]. | *Follow the [[style guide]]. | ||
*Explain concepts in the simplest terms possible -- as if you are explaining something to a five year old! | *Explain concepts in the simplest terms possible -- as if you are explaining something to a five year old! | ||
Revision as of 13:59, 9 February 2024
Use concept documents to learn about fundamental ideas and principles, as opposed to finding factual information or completing a task.
Example
Examples of concepts at Artisan's include:
Writing a concept document
Follow these best practices when writing reference documentation:
- Do not mix document types. Break out tasks or references into their own wiki article.
- Follow the style guide.
- Explain concepts in the simplest terms possible -- as if you are explaining something to a five year old!
- Do not duplicate information that's on a different wiki page -- instead, link to the other page, so that we maintain one source of authoritative information.
- Ask for feedback from others.
- Publish your documentation on the wiki once you're happy with it!
Pages in category "Concept"
The following 3 pages are in this category, out of 3 total.
