Fish out of order

I have managed several documentation libraries with Git (predominantly using GitLab and command line Git). Individual documents were written as Markdown files, and presented to the end-user using static site generators such as Hugo and MkDocs.

​

For each of these libraries, I was either the primary maintainer of the library, or working in tandem with an additional technical writer to manage the workload.

​

These are the kinds of activities I performed in order to maintain the software documentation libraries:

​

• Review, test, define and enforce a logical information architecture.

• Manage documentation governance (who is responsible for what sections of the documentation, how regularly that documentation is reviewed, how versions are managed, the process for retiring a piece of documentation, etc.)

• Monitor documentation issues register, and assign to relevant engineers where necessary.

• Consult with engineers to create and update documentation.

• Review and edit for consistency documentation updates submitted directly by software engineers.

• User test documentation submitted by engineers by following along with their instructions in a development environment.

• Develop and maintain a documentation style guide.

• Create templates for common documentation types (e.g. "How-To" "API Reference").