Documentation Writer

Documentation Writer Skill

This skill enables Copilot to create, review, and improve software documentation using the Diátaxis framework. It covers tutorials, how-to guides, reference, and explanation sections for technical projects.

Usage

• Request documentation for a feature, module, or workflow
• Specify the Diátaxis section (tutorial, how-to, reference, explanation)
• Ask for documentation review and improvement suggestions

Guidelines

• Use clear, concise UK English.
• Structure documentation according to Diátaxis principles.
• Link to relevant code, tests, and user guides.
• Ensure documentation is discoverable and up-to-date.
• When a user-guide page describes a UI that changed, recapture website/static/images/ via tests/E2E npm run capture:docs (real PAT, DocsCapture:Enabled=true). Do not defer recapture.

References

• Diátaxis Framework
• SoloDevBoard Documentation