Document a tool long instructions: Difference between revisions
From Artisans Asylum Wiki
Susanvaughn (talk | contribs) (Create page and add Learning Outcomes) |
Susanvaughn (talk | contribs) (Add Step 1 Instructions) |
||
| Line 1: | Line 1: | ||
=== '''Learning outcomes:''' === | |||
Learning outcomes: | |||
* Create a new tool page on the wiki. | * Create a new tool page on the wiki. | ||
* Learn how to use the [[Template:ToolBox|ToolBox template]] to document basic information about the tool. | * Learn how to use the [[Template:ToolBox|ToolBox template]] to document basic information about the tool. | ||
| Line 9: | Line 7: | ||
** Section Headings | ** Section Headings | ||
* Learn where to find additional resources/help. | * Learn where to find additional resources/help. | ||
=== '''Step 1: The Basics''' === | |||
* If you are brand new to adding content to the wiki, review the . This guide provides basic instructions on getting a password, logging-in, editing mode, etc.. | |||
* Look at the examples of tools currently documented on the wiki. | |||
** [[Flammables Cabinet]] | |||
** [[Angle Grinder]] | |||
** [[:Category:Tools|List of All Tools Currently Documented]] | |||
* Review the [[Template:ToolBox|ToolBox Template]] used on our wiki. | |||
* Review the [[Style guide|Style Guide.]] | |||
* Gather the basic information you have already about the tool: (1) make, model; (2) training requirements; (3) manuals; (4) safety information; (5) pictures; (6) videos; etc… | |||
Tip: For some tools, you will be able to grab images, links to manuals, and specs from the manufacturer’s website. | |||
Revision as of 21:40, 15 February 2024
Learning outcomes:
- Create a new tool page on the wiki.
- Learn how to use the ToolBox template to document basic information about the tool.
- Learn how to add an image to your tool page.
- Learn how to add additional text based information about your tool, using common wiki elements including the following:
- Lists
- Section Headings
- Learn where to find additional resources/help.
Step 1: The Basics
- If you are brand new to adding content to the wiki, review the . This guide provides basic instructions on getting a password, logging-in, editing mode, etc..
- Look at the examples of tools currently documented on the wiki.
- Review the ToolBox Template used on our wiki.
- Review the Style Guide.
- Gather the basic information you have already about the tool: (1) make, model; (2) training requirements; (3) manuals; (4) safety information; (5) pictures; (6) videos; etc…
Tip: For some tools, you will be able to grab images, links to manuals, and specs from the manufacturer’s website.
