Category:Task: Difference between revisions

From Artisans Asylum Wiki
mNo edit summary
mNo edit summary
Line 1: Line 1:
Task documents are instructions that help the reader complete a task. Tasks can typically be done by one person over the course of a couple of hours.
Use task documents to learn how to complete a task, as opposed to [[:Category:Reference|finding factual information]] or understanding a concept.
 
Tasks can typically be done by one person over the course of a couple of hours.


Contrast tasks with processes, which are collections of tasks. Processes often require multiple participants and take days, weeks, or longer.
Contrast tasks with processes, which are collections of tasks. Processes often require multiple participants and take days, weeks, or longer.

Revision as of 13:55, 9 February 2024

Use task documents to learn how to complete a task, as opposed to finding factual information or understanding a concept.

Tasks can typically be done by one person over the course of a couple of hours.

Contrast tasks with processes, which are collections of tasks. Processes often require multiple participants and take days, weeks, or longer.

Example

Examples of tasks at Artisan's include:

  • Focusing the laser on the laser cutter
  • Reserving a tool
  • Changing the speed of a drill press
  • Creating a tool page on the wiki

Writing a task document

Follow these best practices when writing task documentation:

  • Draft your documentation on a collaboration platform like Google Docs first
  • Follow the style guide
  • Test your documentation by trying to complete the task using the instructions
  • Ask for feedback on your draft from others
  • Publish your documentation on the wiki once you're happy with it!