Back to Details

technical-documentation

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Technical Documentation

技术文档

Purpose

目的

Produce and review technical documentation that is clear, actionable, and maintainable for both humans and agents.

生成并审核清晰、实用且易于维护的技术文档，同时满足人类和Agent的使用需求。

When to use

使用场景

Creating or overhauling docs in an existing product/codebase (brownfield).
Building evergreen docs meant to stay accurate and reusable over time.
Reviewing doc diffs for structure, clarity, and operational correctness.

在现有产品/代码库中创建或全面修订文档（brownfield场景）。
构建可长期保持准确、可重复使用的evergreen文档。
审核文档差异，检查其结构、清晰度和操作正确性。

Workflow

工作流程

Classify task:
```
build
```
or
```
review
```
; context:
```
brownfield
```
or
```
evergreen
```
.
Read
```
references/principles.md
```
for the governing ruleset (Matt Palmer + OpenAI).
For build tasks, follow
```
references/build.md
```
.
For review tasks, follow
```
references/review.md
```
.
Use
```
references/tooling.md
```
when platform/tooling choices affect recommendations.
In brownfield mode, prioritize compatibility with current docs IA, tooling, and release state.
In evergreen mode, prioritize timeless wording, update strategy, and durable structure.
Return deliverables plus validation notes and remaining gaps.

分类任务：分为
```
build
```
（构建）或
```
review
```
（审核）；场景分为
```
brownfield
```
或
```
evergreen
```
。
阅读
```
references/principles.md
```
文档，遵循其中的规则集（基于Matt Palmer + OpenAI制定）。
对于构建任务，遵循
```
references/build.md
```
的指导。
对于审核任务，遵循
```
references/review.md
```
的指导。
当平台/工具选择会影响建议时，参考
```
references/tooling.md
```
。
在brownfield模式下，优先保证与当前文档信息架构（IA）、工具和发布状态的兼容性。
在evergreen模式下，优先考虑措辞的时效性、更新策略和持久化结构。
返回交付成果，以及验证说明和待填补的空白。

Inputs

输入信息

Doc type (tutorial, how-to, reference, explanation) and audience.
File scope or diff scope.
Docs framework/tooling constraints (Fern, Mintlify, Sphinx, etc.).
Build/review mode and brownfield/evergreen intent.

文档类型（教程、操作指南、参考文档、说明文档）和目标受众。
文件范围或差异范围。
文档框架/工具限制（如Fern、Mintlify、Sphinx等）。
构建/审核模式以及brownfield/evergreen的定位。

Outputs

输出成果

Updated draft or review findings with clear next actions.
Validation notes (what was checked, what remains).
Navigation/maintenance recommendations for long-term quality.

更新后的草稿或带有明确后续行动的审核结果。
验证说明（已检查内容、待检查内容）。
针对长期质量的导航/维护建议。