tech-writer
A GitHub Copilot skill based on Google's Technical Writing Course that reviews and improves technical documentation.
Installation
Copy or symlink this repo into your project's skill directory:
# Project-level (shared with team) cp -r /path/to/tech_writer .github/skills/tech-writer # Personal (across all projects) cp -r /path/to/tech_writer ~/.copilot/skills/tech-writer
Or clone directly:
# Personal git clone https://github.com/cherczeg/tech_writer.git ~/.copilot/skills/tech-writer
Usage
Once installed, the skill is available via /tech-writer in GitHub Copilot chat, or invoked automatically when Copilot detects you're working on documentation tasks.
The skill uses ~/.tech_writing_ghcp/ as a staging directory for drafts, reviews, and cached analysis during tech writing operations.
What's Included
SKILL.md
The skill definition with a 10-step review procedure and new document writing workflow.
References
Course content organized into two modules:
Technical Writing One (references/one/)
- Just Enough Grammar
- Words (terminology, acronyms, pronouns)
- Active Voice
- Clear Sentences
- Short Sentences
- Lists and Tables
- Paragraphs
- Audience
- Documents
- Punctuation
- Markdown
Technical Writing Two (references/two/)
- Self-Editing
- Organizing Large Documents
- Illustrating
- Creating Sample Code
- Using LLMs in Technical Writing
Attribution
Course content is derived from Google's Technical Writing Courses, used for educational reference purposes.