technical-documentation

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Technical Documentation

技术文档

Maintains two project artifacts:

analise.md

(technical analysis) and

plano.md

(implementation plan). Create or update them during technical discussions or when the user asks for analysis or plan documentation.

维护两个项目工件：

analise.md

（技术分析文档）和

plano.md

（实施计划文档）。在技术讨论期间或用户要求提供分析/计划文档时，创建或更新这两个文档。

analise.md

Purpose: Record critical points, decisions, and Q&A from technical discussions.
Format: Markdown with clear headings and separators.
Contents: Key decisions, trade-offs, open questions, and answers.
When: Create at the start of a technical discussion; update as decisions are made.

用途：记录技术讨论中的关键点、决策以及问答内容。
格式：采用Markdown格式，使用清晰的标题和分隔符。
内容：关键决策、权衡方案、待解决问题及答案。
时机：在技术讨论开始时创建；随着决策的确定逐步更新。

plano.md

Purpose: List small, concrete tasks to support implementation and rollback.
Format: Markdown; checklist-style items.
Contents: Tasks derived from
```
analise.md
```
,
```
funcoes.md
```
, and other project docs.
When: Create after or with analysis; update as tasks are completed or changed.

用途：列出具体的小型任务，为实施与回滚提供支持。
格式：Markdown格式；采用清单式条目。
内容：源自
```
analise.md
```
、
```
funcoes.md
```
及其他项目文档的任务。
时机：在分析完成后或同步分析过程创建；随着任务完成或变更进行更新。

Workflow

工作流程

Starting a technical discussion: Create or open
```
analise.md
```
; note scope and main questions.
As decisions are made: Update
```
analise.md
```
with decisions and rationale.
Planning implementation: Create or update
```
plano.md
```
with actionable tasks.
As work progresses: Check off or adjust items in
```
plano.md
```
.

Keep both files at project root. Use consistent Markdown (headings, lists, code blocks) and avoid duplicating long content; reference other docs instead.

启动技术讨论：创建或打开
```
analise.md
```
；记录讨论范围及核心问题。
决策确定后：在
```
analise.md
```
中更新决策内容及理由。
规划实施阶段：创建或更新
```
plano.md
```
，添加可执行任务。
工作推进过程中：勾选或调整
```
plano.md
```
中的条目。

将两个文档保存在项目根目录下。使用统一的Markdown格式（标题、列表、代码块），避免重复冗长内容，改为引用其他文档。