用途:为技术文档提供模板与有明确主张的结构,覆盖 README、架构决策记录(ADR)、OpenAPI 规范、变更日志和写作风格五类,每类在 rules/ 目录下有独立规则文件,按需加载。
主要能力:README 规则(HIGH)用于启动项目、引导贡献者;ADR 规则(HIGH)用于记录架构决策;API Docs 规则(HIGH)用于以 OpenAPI 3.1 编写 REST API 文档;Changelog 规则(MEDIUM)用于维护发布历史;Writing Style 规则(MEDIUM)适用于任何技术写作任务。共 5 条规则、5 个类别。
使用方式:README 骨架为项目名→简要描述→快速开始→安装→使用→API→配置→贡献→许可证。ADR 格式为 ADR-001 标题→状态→背景→决策→后果(正面/负面)→参考。OpenAPI 最低要求为 openapi: 3.1.0,含 info、paths、components/schemas 和错误响应。变更日志条目按 Added/Changed/Deprecated/Removed/Fixed/Security 分节。写作原则:主动语态、现在时、第二人称、一句一个观点。
适用场景:开源或内部项目的 README 编写、架构决策记录、REST API 文档、发布历史维护及通用技术写作。
限制:资料未提供具体安装命令、收费方式、平台支持或效果数据;相关技能包括 ork:api-design、ork:architecture-decision-record、ork:release-management。版本 1.0.0(2026 年 3 月)。