Category:Reference: Difference between revisions

From Artisans Asylum Wiki
(Reference category)
 
mNo edit summary
Line 1: Line 1:
Use reference documents when you need to find factual information, as opposed to [[:Category:Task|completing a task]] or understanding a concept.
Use reference documents when you need to find factual information, as opposed to [[:Category:Task|completing a task]] or [[:Category:Concept|understanding a concept]].


Reference articles primarily contain reference material, typically tables, lists, charts, or simple statements of fact.
Reference articles primarily contain reference material, typically tables, lists, charts, or simple statements of fact.
Line 10: Line 10:
===Writing a reference document===
===Writing a reference 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 into their own wiki article.
*Do not mix document types. Break out [[:Category:Task|tasks]] or [[:Category:Concept|concepts]] into their own wiki article.
*Follow the [[style guide]].
*Follow the [[style guide]].
*Double-check the accuracy of your information.
*Double-check the accuracy of your information.

Revision as of 14:03, 9 February 2024

Use reference documents when you need to find factual information, as opposed to completing a task or understanding a concept.

Reference articles primarily contain reference material, typically tables, lists, charts, or simple statements of fact.

Example

Examples of references at Artisan's include:

Writing a reference document

Follow these best practices when writing reference documentation:

  • Do not mix document types. Break out tasks or concepts into their own wiki article.
  • Follow the style guide.
  • Double-check the accuracy of your information.
  • 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!