documentation-production

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Documentation Production

文档制作

Overview

概述

Provide a consistent, low-friction workflow for producing documentation across formats: focused docs, indexes, diagrams, tutorials, and learning paths. Keep outputs structured and aligned with the repo's docs conventions.

为跨格式制作文档提供一致、低门槛的工作流，涵盖聚焦型文档、索引、图表、教程及学习路径。确保输出内容结构化，并与代码库的文档规范保持一致。

When to Use

适用场景

Generating or updating documentation for components, APIs, or features
Building a project index or knowledge base
Creating Mermaid diagrams for system behavior or architecture
Writing tutorials, workshops, or learning paths
Explaining concepts for onboarding or education

Avoid when:

The request is primarily a code change (use implementation workflows)
The doc type is a one-off note that doesn't need structure

生成或更新组件、API或功能的文档
构建项目索引或知识库
创建用于展示系统行为或架构的Mermaid图表
编写教程、工作坊材料或学习路径
为新员工入职或知识普及讲解概念

不适用场景：

请求主要涉及代码变更（请使用实现类工作流）
文档类型为无需结构化的一次性笔记

Quick Reference

快速参考

Task	Load reference
Generate focused docs	`skills/documentation-production/references/generate.md`
Project index/knowledge base	`skills/documentation-production/references/index.md`
Mermaid diagrams	`skills/documentation-production/references/diagrams.md`
Teach concepts / learning paths	`skills/documentation-production/references/teacher.md`
Tutorials / workshops	`skills/documentation-production/references/tutorials.md`
Writing process & style	`skills/documentation-production/references/writing-process.md`

任务	参考文件路径
生成聚焦型文档	`skills/documentation-production/references/generate.md`
项目索引/知识库	`skills/documentation-production/references/index.md`
Mermaid图表	`skills/documentation-production/references/diagrams.md`
概念讲解/学习路径	`skills/documentation-production/references/teacher.md`
教程/工作坊材料	`skills/documentation-production/references/tutorials.md`
写作流程与风格	`skills/documentation-production/references/writing-process.md`

Workflow

工作流

Identify doc type and target audience.
Load the relevant reference file(s) for structure and patterns.
Gather source material from code or existing docs.
Produce the artifact using the required format.
Validate accuracy and consistency with repo conventions.
Summarize changes and next steps.

确定文档类型与目标受众。
加载相关参考文件，获取结构与范式。
从代码或现有文档中收集素材。
按要求格式生成文档成品。
验证内容准确性及与代码库规范的一致性。
总结变更内容与后续步骤。

Output

输出成果

The documentation artifact(s)
Brief change summary and any follow-up gaps

文档成品
简短的变更总结及待跟进的缺口

Common Mistakes

常见误区

Skipping source review and guessing behavior
Mixing tutorial/guide formats without clear intent
Creating diagrams without labels or accessibility notes
Updating docs without adjusting indexes or nav links

跳过源文件审查，仅凭猜测编写内容
未明确意图就混用教程/指南格式
创建图表时未添加标签或无障碍说明
更新文档后未同步调整索引或导航链接