If you're confused about where to start in documenting a software product as a Technical Writer, read this! 👇
In my experience of creating API/Developer and, most especially, Product Documentation, I’ve found that one of the best approaches to creating high-quality and useful docs is to place yourself in the shoes of the user.
Use the software product as someone external to the platform and ask the questions a regular user would most likely ask.
Then, document the answers to those questions (not in a Q&A format). Write the documentation in a way that you, as a user, would understand.
While writing or creating the product docs, if you notice that some parts need thorough explanation, write it.
Document the areas where you feel the users would be confused. Document the product like a user!
If you know of other methods we can use as Technical Writers, let me know in the comments!
#TechnicalWriter#APIDocumentation#DeveloperDocumentation#ProductDocumentation#UserDocumentation