specsfy-documentator

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Documentar o sistema

系统文档编写

Modo de interação

交互模式

Modo de interação:

sem perguntas

. Não formule perguntas nesta skill. Registre como não identificado todo dado que as fontes executáveis não sustentarem.

Ler instruções locais,
```
PROJECT.md
```
,
```
.specsfy/STACK.md
```
,
```
.specsfy/RULES.md
```
,
```
.specsfy/DATABASE.md
```
, manifests, lockfiles, metadados instalados e código existente.
Ler o padrão documental antes de alterar a topologia publicada.
Construir toda a documentação e
```
.specsfy/PACKAGES.md
```
, mesmo quando a skill for acionada sem uma spec ou implementação recente:
bash
```
node scripts/build_documentation.mjs --project <raiz>
```
Inspecionar os arquivos gerados e corrigir manualmente somente inferências que o código não sustente. Não inventar decisões, relações ou integrações.

Executar

--check

para provar que a documentação representa o estado atual:

bash

node scripts/build_documentation.mjs --project <raiz> --check

Preservar conteúdo humano fora dos blocos
```
specsfy:documentator
```
, inclusive em
```
.specsfy/PACKAGES.md
```
. Tratar o bloco como projeção reconstruível das fontes locais.
Registrar na evidência da tarefa o comando, resultado e arquivos atualizados.

交互模式：

无提问

。在此skill中请勿提出问题。对于可执行源无法支撑的所有数据，标记为未识别。

读取本地说明文档、
```
PROJECT.md
```
、
```
.specsfy/STACK.md
```
、
```
.specsfy/RULES.md
```
、
```
.specsfy/DATABASE.md
```
、清单文件、锁定文件、已安装元数据及现有代码。
在修改已发布的文档结构前，先阅读文档标准。
构建完整文档及
```
.specsfy/PACKAGES.md
```
，即使该skill未基于最新规格或实现触发：
bash
```
node scripts/build_documentation.mjs --project <raiz>
```
检查生成的文件，仅手动修正代码无法支撑的推断内容。不得凭空编造决策、关联或集成逻辑。

执行

--check

命令验证文档是否与当前状态一致：

bash

node scripts/build_documentation.mjs --project <raiz> --check

保留
```
specsfy:documentator
```
块之外的人工编写内容，包括
```
.specsfy/PACKAGES.md
```
中的内容。将该块视为本地源可重构的投影内容。
在任务证据中记录使用的命令、执行结果及更新的文件。

Cobertura obrigatória

必选覆盖范围

Manter em

docs/

portal e roteiro de leitura;
arquitetura, componentes e UML em Mermaid;
inventário da aplicação e implementações existentes;
banco e entidades com
```
erDiagram
```
;
fluxos com
```
flowchart
```
e
```
sequenceDiagram
```
;
guia e resumo dos testes;
frontend, views, React e Tailwind;
bibliotecas e pacotes nativos, de framework, integrados e terceiros, com versão, fonte e referência GitHub;
integrações e variáveis de configuração sem valores sensíveis;
decisões explícitas e suas fontes.

Manter em

.specsfy/PACKAGES.md

todos os pacotes npm e Composer encontrados nos manifests e lockfiles do projeto, inclusive dependências transitivas registradas localmente;
gerenciador, escopo, nome, versão, finalidade curta e fonte de cada pacote;
descrição declarada no lockfile ou pacote instalado quando existir;
aviso explícito quando os metadados locais não comprovarem a finalidade.

Para Laravel, mapear rotas, controllers, models, services, jobs, policies, Blade, migrations e Pest/PHPUnit. Para Node, Next.js, React ou Astro, mapear páginas, rotas de API, componentes, módulos, scripts e Vitest/Jest/Node Test.

在

docs/

目录下维护以下内容：

文档门户与阅读路线图；
架构、组件及Mermaid格式的UML图；
应用清单及现有实现；
使用
```
erDiagram
```
表示的数据库与实体；
使用
```
flowchart
```
和
```
sequenceDiagram
```
表示的流程；
测试指南与摘要；
前端、视图、React及Tailwind相关内容；
原生、框架、集成及第三方库与包，包含版本、来源及GitHub参考链接；
集成信息及不含敏感值的配置变量；
明确的决策依据及来源。

在

.specsfy/PACKAGES.md

中维护以下内容：

项目清单文件和锁定文件中所有的npm与Composer包，包括本地已记录的间接依赖；
每个包的包管理器、作用域、名称、版本、简短用途及来源；
锁定文件或已安装包中已声明的描述（若存在）；
当本地元数据无法验证用途时，需明确标注。

对于Laravel项目，需映射路由、控制器、模型、服务、任务、策略、Blade、迁移及Pest/PHPUnit相关内容。对于Node、Next.js、React或Astro项目，需映射页面、API路由、组件、模块、脚本及Vitest/Jest/Node Test相关内容。

Limites

限制条件

Não copiar segredos, valores de
```
.env
```
, dados de produção ou código inteiro.
Não apresentar heurística como decisão confirmada.
Não substituir specs,
```
PROJECT.md
```
ou arquivos humanos em
```
.specsfy/
```
.
```
PACKAGES.md
```
é a única projeção reconstruída pela skill nesse diretório e preserva conteúdo fora do bloco gerado.
Não exigir rede para construir. Quando o repositório GitHub de um pacote não estiver declarado localmente nem for conhecido, publicar uma busca GitHub claramente rotulada, em vez de inventar uma URL.

不得复制密钥、
```
.env
```
文件中的值、生产数据或完整代码。
不得将推断内容作为已确认的决策呈现。
不得替换规格文档、
```
PROJECT.md
```
或
```
.specsfy/
```
目录下的人工编写文件。
```
PACKAGES.md
```
是该目录下唯一由skill重构的投影文件，且保留生成块之外的内容。
构建过程不得依赖网络。当某个包的GitHub仓库未在本地声明且未知时，需明确标注为GitHub搜索项，而非编造URL。