tomjoht/tomjoht.github.io/internal-skills

One of the best things you can do working in API documentation is get more involved in reviewing source code comments that developers are submitting. Because the comments in source code files (such as java, proto, or other files) become the reference documentation in your docs, it's important that you have a hand in reviewing, editing, and shaping this content. Too many tech writers abdicate their roles when it comes to source code content because the format and conventions might seem a bit unfamiliar. However, this content becomes part of your docs and reflects your content. You'll be in charge of this content, so don't rely on engineers to own it.

There are several steps for getting a handle on source code comments using skills.

1. Add yourself as a Cc to any changelists that engineers make in the code repositories you support.
2. When a changelist comes in, run your skill against it.
3. Review the comments provided and consider any adjustments.

1. Add yourself as a Cc to any changelists that engineers make in the code repositories you support.