Embedded Files
I was responsible for editing or creating comments, using XML, that could be read with our Swagger-type tool.
I also suggested variable and method names to clarify samples.
As part of the doc team at Unity, I wrote and updated doc on a wide variety of topics, from authentication to monetization. In addition, we peer-reviewed each others' work. So, for example, I peer-reviewed cloud doc linked here, and mentored junior writers. We started out making doc in Markdown but eventually moved to MadCap Flare,Swagger, Redocly, and similar tools.
At Burroughs (later UNISYS), one of three projects was this Programming Reference Manual. Carolyn pulled out selected pages to illustrate that she created a layout that made it easy for programmers to find what they needed, quickly. Carolyn also worked with graphic artists to interpret engineering concepts.
Google Sites
Report abuse