pflow-docs 是一套用户文档写作规则。适用范围包括任意层级的 README*、docs/ 下的全部内容,以及面向人的根级 Markdown(CONTRIBUTING.md、CHANGELOG.md、SECURITY.md 等)。项目的 AGENTS.md/CLAUDE.md 或用户可重新定义范围,以其定义为准;厂商文本、截取文本或生成文本为只读。
用途:为没看过代码或对话的读者写文档,像口头向同事解释一样。每条句子增加新事实,删去铺垫、复述式结尾、无人提出的“不是 X 而是 Y”式表达。禁止夸大(key、crucial、robust 等),要具体到数字、名称或命令。只描述当前为真的情况,历史放入 CHANGELOG.md 或迁移指南。一个概念一个名称,术语按词汇表原样使用,标识符、命令、路径与字段用反引号。
主要能力:读取 AGENTS.md/CLAUDE.md 的项目文档约定与词汇表(如 GLOSSARY.md 等,常常不存在),项目约定优先,冲突时说明。语言取自文档或项目其他文档;俄语另需读 .agents/skills/pflow-docs/references/ru.md,约 80% 采用 УТР 风格(ГОСТ Р 58049-2017),措辞不确定时查 ru-utr.md。
使用方式:核对每条命令、选项、路径和名称与代码、清单或用户一致;缺口不得猜测,应询问或省略。规则仅适用于你撰写或修改的文本,其他违规先报告,被要求时才改写。完成前确认没有丢失或新增事实,并排查常见痕迹;对安全可运行的文档命令实际执行,失败视为发现而非停止。
形式要求:列表仅用于真实枚举;加粗只用于警告;标题用句首大写,只有一个 H1,不跳级;代码块带语言标签且原样粘贴,不写 $ 提示符,输出放独立块;表格需有多个条目与属性。
README 结构:仅保留适用章节,按序为项目名与一句话说明、单行状态徽章、Quickstart(最多五步、一个可复制块、预期结果)、Usage(2–4 个真实场景,由简到繁)、Configuration(option/default/meaning 表格)、docs/ 链接(多文档时用 File | What's inside 索引表)、Contributing、license。每个 docs/ 文件聚焦一个主题,首段说明读完后读者能做什么。
限制:不编造功能、收费、价格、平台、效果或步骤;资料未提供的内容暂未提供。