Category:Reference: Difference between revisions

From Artisans Asylum Wiki
mNo edit summary
No edit summary
Line 16: Line 16:
*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]]

Revision as of 14:04, 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!