Last updated on Sep 22, 2022
André Sato, Lead Technical Writer at Wildlife Studios joins us in this episode of Knowledgebase Ninjas.
Connect with Andre and Wildlife Studios here:
Wildlife Studios documentation department is only one year old
Andre has been in the technical writing game for five years now, but only joined Wildlife Studios recently to help set up their documentation process and department. Software documentation is a relatively new area in Brazil, so it wasn’t always something that Andre wanted to do, but when he discovered it, it became clear that he wanted to be involved.
Only internal documentation…
Unlike most guests, Andre currently only writes documentation for in house development teams that are building their games.
This acts as a remedy to “knowledge loss”, without the documentation… all of this remains in their head and is lost if the developer moves to a different project or to a different business.
How to measure the success of internal documentation
Andre is able to measure the success of his internal documentation by tracking how many extra meetings are requested by developers. He has found that there has been a significant reduction in these meetings requested since Andre has started producing quality onboarding documentation.
Quality is managed in a very organic way, if a developer finds an issue with the documentation, they just reach out to Andre and requests he improves this.
Andre recommends: Write The Docs
Like many other guests, Andre recommends the Write The Docs community to anyone who is looking to get into documentation. We will be having a guest on the podcast from Write The Docs shortly!
“Make sure the subject is crystal clear before you start writing”
Andre’s one piece of documentation related advice to his twenty one year old self would be to ensure that the subject of your document is crystal clear in your mind before you attempt to commit this to paper – it will save you a lot of time!