Strong documentation requires writing clear steps with direct language. Good documentation is easier to create when the creator is familiar with the tasks being documented. However, because beginners sometimes rely on documentation, it is important to ensure that the documentation is written in a way that does not assume the reader knows anything about how and why a task is done. Creating good documentation requires familiarity with a tool or procedure as well as the ability to see it as a beginner would.
For my project, we will need to document the procedures used to create the lesson plans. This can include aspects such as what is included in the heading of documents, the fonts and designs used on certain materials, the terminology, and the instructions for adding the resources to the project’s website. For some areas of the project’s documentation, I will need to learn about the digital tools we are using for the Native History Project and practice these skills. Next, I will reflect on what procedures we used, why we used them, and how to describe them to a beginner. Then I will write my documentation while striving to be as clear as possible.
