# Doc Writing

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

- Skill: `majiayu000/doc-writing` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds add majiayu000/doc-writing`
- Raw SKILL.md: https://api.skillmd.com/api/skills/majiayu000/doc-writing/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Data & Analytics
- Author: majiayu000 (https://skillmd.com/u/majiayu000)
- Updated: 2026-09-09
- Page: https://skillmd.com/skills/majiayu000/doc-writing

---


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