文档
- 作者仓库星标 4
- 许可证 MIT
- 作者仓库 product-factory-os
- 领域
- 文档
- 作者声明的智能体
- 未找到明确声明;不据此推断已兼容或已测试
- 静态检查
- 94 / 100 · 启发式扫描,不代表运行安全
- 运行环境证据
- 未执行;当前没有隔离运行测试证据
- 作者 / 版本 / 许可证
- @hihol-labs · MIT
- 上下文用量评级
- 低消耗
- 接入复杂程度
- 即装即用
- 是否需要外部接口密钥
- 不需要
- 兼容的系统
- 未声明(默认跨平台)
- 运行环境要求
- 未检出明确要求
- 检测到的文件与系统行为
-
- 只读
- 允许写入 / 修改
- 读取环境变量
- 网络行为
- 仅限本地
- 安装命令数
- 无(仅作为资料)
需要注意: 未声明工具权限范围;实际权限由运行环境决定。
# Doc
Write documentation that matches the project.
## Process
1. Read existing docs and code.
2. Identify the audience: user, developer, operator, maintainer.
3. Update the smallest relevant document.
4. Include commands, environment variables, and examples when useful.
5. Verify commands if practical.
## Self-validation
Before final output, verify:
- Route, side-effect, and confirmation requirements match metadata.
- Required artifacts or read-only result are explicit.
- Verification, blockers, and next route are stated.
## Rules
- Do not document features that do not exist.
- Do not create a new docs system for a small change.
- Keep generated docs concise and maintainable.
章节与文件索引
按说明文件中的顺序排列。
工艺流程
自我验证
规则
文件/命令 -> 原文未列出明确文件或命令
内容校验值 -> 3eba1eadda74
当前原文的自动摘译,尚未人工审校。
工艺流程
阅读现有的文档和代码。确定受众:用户、开发人员、操作员、维护者。更新最小的相关文档。包括有用的命令、环境变量和示例。验证命令(如果可行)。
自我验证
在最终输出之前,验证:路由、副作用和确认要求与元数据匹配。所需的工件或只读结果是明确的。说明了验证、阻止程序和下一步路线。
规则
不要记录不存在的功能。不要为了一个小改动而创建一个新的文档系统。保持生成的文档简洁且可维护。