# Project Doc

> 审查、整理项目声明的长期工程文档，或同步实现变化影响的稳定工程事实。治理范围以仓库声明为准。

- Skill: `neavo/project-doc` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add neavo/project-doc`
- Raw SKILL.md: https://api.skillmd.com/api/skills/neavo/project-doc/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: neavo (https://skillmd.com/u/neavo)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/neavo/project-doc

---


# 项目长期文档治理

使未来维护所需的稳定工程事实准确、易于定位，并各有一个权威归宿。按仓库行动规则确定任务模式、治理范围和验证入口。

## 范围与收录

使用项目声明的长期文档集合；声明不完整时，以现有入口、引用和用户指定的长期文档目标确定范围。开发行动规则、产品运行时资源和其它材料按各自消费方维护，可作为事实证据或引用检查面。

信息同时满足以下条件时收录：

- 描述当前有效的稳定事实。
- 改变未来维护者对落点、边界、契约、行为或验证的判断。
- 需要跨文件或跨层重建，或承载非显然理由、公开契约、关键入口。
- 能确定一个权威归宿；涉及多个主题时拆分信息，其它文档保留定位所需的短引用。

## 证据与处理

|待确认的事实|优先证据|
|---|---|
|运行行为|实现、行为测试、运行配置|
|公开或结构化契约|schema、类型、协议定义、契约测试|
|治理规则、入口和验证要求|仓库行动规则、配置、脚本、文档索引|
|任务要求改变的事实|用户要求及完成后的实现|

证据冲突时回到拥有决策权且最接近实际行为的来源；无法判定的内容列为未决。用户指定保留内容按用户要求保留；工具链入口、外部流程入口和生命周期不明的材料，应先确认用途再决定处理。

围绕证据选择处理方式：更新变化的事实、补齐稳定缺口、清理失效或不满足收录标准的信息、合并重复正文、迁移错位内容。信息归属或组织已经变化时，重写相关信息块。

局部同步只检查相关事实与引用；问题涉及多个文档时，沿重复事实、归属和入口扩大检查。迁移关系较多、难以直接核对时，使用辅助清单记录证据与去向。

## 完成证据

- 相关事实准确，重复与错位已处理，失效信息已清理，稳定缺口已补齐；现状符合要求时报告检查依据。
- 入口变化后检查仓库文档、README、脚本提示、测试断言及技能中的受影响引用，并按项目入口完成相关验证。
- 修改任务按实际信息变化与验证结果交付；审查任务报告位置、证据、影响和建议。保留有争议的内容或存在未决问题时说明依据。