---
name: doc-writing
description: 技术文档工程 - Diátaxis框架 / PDF / DOCX / XLSX / PPTX 处理。Create, maintain, and structure clear technical documentation.
---

# 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.

1.  **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).
2.  **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.
3.  **Reference (Information-oriented)**: Technical description of machinery.
    - *Example*: "User API Class Specification."
    - *Tone*: Dry, accurate, complete.
4.  **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](resources/diataxis.md) (Understanding the 4 types) |
| **README Standard** | [readme-template.md](resources/readme-template.md) (The Gold Standard) |
| **Style Checklist** | [style-guide.md](resources/style-guide.md) (Writing rules) |


---
Source attribution: VidyFoo
Original project: https://github.com/VidyFoo/antigravity-skill-engine/blob/9502732b0d755102321c3aec1db1b8f5aa9497ef/.agent/skills/4-tools/doc-writing/SKILL.md
License: MIT
License information: https://opensource.org/license/mit
Original upstream instructions; downloaded from Dave AI.

## Upstream license notice

MIT License

Copyright (c) 2026 Antigravity Lab

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.



# Dave AI resource metadata

Creator / publisher: VidyFoo
Original project: https://github.com/VidyFoo/antigravity-skill-engine/blob/9502732b0d755102321c3aec1db1b8f5aa9497ef/.agent/skills/4-tools/doc-writing/SKILL.md
Attribution basis: Recovered original package and original project license at a pinned revision

Fields of work: Content & Media, Design, Project & Program Management
Roles: Project Manager, Technical Writer, UX Writer
Specialties: Word Documents, Excel, PowerPoint
Tools: Google Docs, Google Sheets, Microsoft Excel, Microsoft PowerPoint, Microsoft Word
Country applicability: Country not specified
Classification basis: Source catalog labels
Instruction SHA-256: d16c4d84972787411ccfbedb763d137e248170365f36ecedcac02be21fab8bb8
Metadata reviewed: 2026-10-27
This metadata supersedes earlier Dave AI catalog attribution. Original instruction and supporting files are preserved.