Category:Concept: Difference between revisions
From Artisans Asylum Wiki
Acharlwood (talk | contribs) (Concept category) |
Acharlwood (talk | contribs) mNo edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
Use concept documents to learn about fundamental ideas and principles, as opposed to [[:Category:Reference|finding factual information]] or [[:Category:Task|completing a task]]. | Use concept documents to learn about fundamental ideas and principles, as opposed to [[:Category:Reference|finding factual information]] or [[:Category:Task|completing a task]]. | ||
=== | ===Examples=== | ||
Examples of concepts at Artisan's include: | Examples of concepts at Artisan's include: | ||
*[[Subject matter experts]] | *[[Subject matter experts]] | ||
===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 [[:Category:Task|tasks]] or [[:Category:Reference|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! | ||
| Line 12: | Line 12: | ||
*Ask for feedback from others. | *Ask for feedback from others. | ||
*Publish your documentation on the wiki once you're happy with it! | *Publish your documentation on the wiki once you're happy with it! | ||
[[Category:A2 Wiki Help]] | |||
Latest revision as of 14:03, 9 February 2024
Use concept documents to learn about fundamental ideas and principles, as opposed to finding factual information or completing a task.
Examples
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.
