Documentation is most valuable when done in smaller chunks and repeatedly reviewed throughout the project.
This sample was created with the free GitBook platform version using a limited theme design.
Using an approach that is iterative, the process of working on documentation is ongoing and repeated until done.
As a technical writer, you need to have a fair idea of what should be the document type, content, subject area, or domain of writing (i.e. instructional), scope, and goals, as well as the most important, who will be the target audience.
You have to keep in mind that the reader’s goal is what guides your entire writing progression where the documentation must fulfil their needs and answer their questions.
What users need is information to solve a task at hand. The documentation should encourage them to do this with a minimum of systematic instruction.
Good writing means that the message is directly clear to the projected audience.
Technical writing is not a place for elegant and dense prose. It’s not about writing a mystery novel. There should not be a plot twist or surprise ending — just clear steps, info, and examples.