Doc writing
Skill VidyFoo/antigravity-skill-engine/.agent/skills/4-tools/doc-writing
Antigravity Skills Engine (ASE) - The ultimate Claude Skills library for AI agents featuring 16+ industrial-grade professional tracks.
npx -y skills add VidyFoo/antigravity-skill-engine --skill doc-writingAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- 11 stars11 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
What its author says it does
Copied from the file, not written here
技术文档工程 - Diátaxis框架 / PDF / DOCX / XLSX / PPTX 处理。Create, maintain, and structure clear technical documentation.
SKILL.md
1.9 KB, as published. Nobody here has run it
Documentation Engineering
Purpose
Code tells you how. Documentation tells you why and what. We treat documentation as an engineering artifact: structured, versioned, and maintained.
When to Use This Skill
- New Project: "Write a README."
- Knowledge Transfer: "Explain how this works."
- API: "Document this endpoint."
- Handover: "Create a user guide."
Core Framework: Diátaxis
Classify your document into one of four quadrants to ensure clarity.
- Tutorials (Learning-oriented): A lesson to get a beginner started.
- Example: "Build your first Todo App in 5 minutes."
- Tone: Inspiring, step-by-step, no choices (follow me).
- How-to Guides (Problem-oriented): A recipe to solve a specific problem.
- Example: "How to reset your password."
- Tone: Practical, concise, steps 1-2-3.
- Reference (Information-oriented): Technical description of machinery.
- Example: "User API Class Specification."
- Tone: Dry, accurate, complete.
- Explanation (Understanding-oriented): Context and background.
- Example: "Why we chose Rust over C++."
- Tone: Discursive, theoretical.
Google Style Guide Highlights
- Voice: Active, not passive. ("Click the button", not "The button should be clicked").
- Second Person: Speak to "you" (the user).
- Simplicity: Use short sentences and plain language.
Resource Files
| Topic | File |
|---|---|
| Framework Deep Dive | diataxis.md (Understanding the 4 types) |
| README Standard | readme-template.md (The Gold Standard) |
| Style Checklist | style-guide.md (Writing rules) |