documentation-currency
检测过时的文档 - 陈旧的状态标记、旧的TODO项、版本滞后
把 Skill 的源码、资源快照、README、包体和安装信号放进一个可搜索、可筛选的公开目录。
检测过时的文档 - 陈旧的状态标记、旧的TODO项、版本滞后
你处理文档Docusaurus的方法。在处理涉及Docusaurus文档的文件时使用此技能。
技术文档、API参考、用户指南、维护文档质量。用于文档、docs、用户文档、api-docs、指南、readme标签。提供文档模式、验证、清晰度标准。
在实现新功能或修复错误后,请确保记录更改。在完成功能或错误修复的实现阶段后使用
在需要将文档网站抓取为markdown格式以供AI上下文使用时采用。触发词包括“scrape docs”、“download documentation”、“get docs for [library]”,或者创建在线文档的本地副本。重要 - 在抓取之前一定要先分析站点地图。
在创建、审查或改进项目文档(README、架构文档、指南、参考)时,应用一致的文档标准和样式指南。此技能应在编写新文档、审查现有文档以保持风格一致性,或用户请求改进文档或检查是否符合样式指南时使用。
更新所有项目文档,包括实施文档、用户
为代码和API创建清晰、可维护的文档。在编写README文件、API文档、代码注释或被要求记录代码时使用。
支持PRD、ADR、设计文档、作业计划书的创建。提供模板和创建判断矩阵。
自动化文档生成模式。涵盖TSDoc、JSDoc、OpenAPI、README模板以及文档即代码工作流。
在创建代码和文档之间的双向链接时使用。涵盖链接模式、文档引用、跨工件上下文保留以及保持代码和文档同步。
用于生成、更新或组织文档(组件/API文档、项目索引、图表、教程、学习路径)- 为文档生成、索引编制、图表制作和教学提供结构化的工作流程和参考资料。
在代码更改时审查并更新MkDocs文档。当完成功能实现、进行了影响用户界面功能的代码更改、审查PR以确保文档完整性,或审核文档覆盖率时,应使用此技能。分析git差异以识别文档缺口,并提供MkDocs Material格式化模式。
保持文档与代码更改同步。在实现功能、修改API、更改架构、添加配置、更新安全或进行任何影响面向用户或开发者的文档的更改时使用。
保持文档与代码和知识的完美同步。与Oracle集成以利用学习成果,与Summoner集成用于设计文档,与Style Master集成用于样式指南。自动生成并更新README、API文档、ADRs以及入职材料。检测陈旧的文档,并确保其随代码库一同演进。
从代码库生成API规范 - 端点、类型、模式。触发条件:API文档、端点文档、API仕様、OpenAPI、Swagger、REST API。
自动维护项目文档,包括CHANGELOG.md、README文件、内联代码文档和交叉引用。在实现功能、修复bug、更改API或完成重要工作后主动使用。按照常规提交格式更新CHANGELOG.md,为新功能添加README部分,为新的函数/结构/组件生成内联文档,并确保文档中的交叉引用是最新的。涵盖Rust文档注释、TypeScript JSDoc、常规提交(feat/fix/docs/refact…
高效的技术项目文档发现、解读和解释方法。适用于解释系统架构、设计原理、实现模式或整合多个文档来源(文本文档、代码注释、图表、测试描述)时使用。提供策略以浏览大型文档集,提取设计意图,交叉引用多个来源,并综合全面的解释。
通过使用评估清单和转换模式,系统地将文档质量从7/10提升至9/10。当文档存在但缺乏快速入门、清晰的前提条件或有效的示例时使用。特别优化适用于加密/交易数据项目。
定义了在编写代码前查询Context7以验证文档的标准操作程序。在使用Appwrite、Next.js或任何第三方SDK时,请遵循此流程。
使用版本文件适配器同步任何项目类型的版本号
文档模板和结构指南。README、API文档、代码注释以及对AI友好的文档。
在开发过程中发现新功能、配置或最佳实践时自动更新CLAUDE.md及相关文档
根据八大规则和Diataxis框架编写清晰、易于发现的软件文档。在创建README文件、API文档、教程、操作指南或任何项目文档时使用。自动执行docs/位置、链接要求和可运行示例。