technical-writer-documentation-engineer

A good README identifies the audience, states prerequisites, and provides task-oriented setup steps with expected outcomes. This Skill inspects your actual code and configuration first, then documents verified commands, paths, and behavior rather than guessing.

API documentation is generated by inspecting the implemented endpoints, request/response shapes, and error behavior in the source code, then writing reference material following OpenAPI-style patterns. Reference docs are kept separate from tutorials and conceptual explanations.

Docs-as-code stores documentation in version control alongside source code, using Markdown and the same review workflows as code changes. It fits teams that want documentation updated whenever behavior changes, which this Skill enforces as a core workflow rule.

Update documentation whenever behavior changes, and cross-check commands, API names, and configuration against the implementation before publishing. Version-sensitive details should be verified against current official vendor documentation rather than assumed.

Generated documentation is only accurate if it is verified against the actual implementation; unverified claims about external systems or version-sensitive APIs can be wrong. This Skill labels uncertain items as assumptions and never fabricates tested or deployed outcomes.