Category:Reference: Difference between revisions

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:

• What tools we have
• A list of all the calendars we use
• Our organizational structure

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.
• Make sure that lists are organized into bulleted items and sections and tables have sortable columns. Make it easy for the reader to find the data they are looking for.
• 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!