documentation-style
在创建、审查或改进项目文档(README、架构文档、指南、参考)时,应用一致的文档标准和样式指南。此技能应在编写新文档、审查现有文档以保持风格一致性,或用户请求改进文档或检查是否符合样式指南时使用。
把 Skill 的源码、资源快照、README、包体和安装信号放进一个可搜索、可筛选的公开目录。
在创建、审查或改进项目文档(README、架构文档、指南、参考)时,应用一致的文档标准和样式指南。此技能应在编写新文档、审查现有文档以保持风格一致性,或用户请求改进文档或检查是否符合样式指南时使用。
更新所有项目文档,包括实施文档、用户
为代码和API创建清晰、可维护的文档。在编写README文件、API文档、代码注释或被要求记录代码时使用。
创建基于症状的调试文档,以匹配开发人员实际搜索解决方案的方式
Rust文档实践用于HASH代码库。在编写文档注释、记录函数/类型/特征/模块、创建错误部分、使用内部文档链接或遵循rustdoc约定时使用。
在创建更快的MDX文档时,用于记录堆栈、数据库或ORM - 重点关注技术变更以及我们在官方设置之外添加的内容
记录所有UI状态变化(默认、空、错误、加载、成功)从Figma设计。在实施前定义完整的UI规范时使用。
RoboLearn平台的Docusaurus文件命名、语法和结构约定
保持文档与代码更改同步。在实现功能、修改API、更改架构、添加配置、更新安全或进行任何影响面向用户或开发者的文档的更改时使用。
保持文档与代码和知识的完美同步。与Oracle集成以利用学习成果,与Summoner集成用于设计文档,与Style Master集成用于样式指南。自动生成并更新README、API文档、ADRs以及入职材料。检测陈旧的文档,并确保其随代码库一同演进。
从代码库生成API规范 - 端点、类型、模式。触发条件:API文档、端点文档、API仕様、OpenAPI、Swagger、REST API。
从代码库分析生成领域文档 - 实体、术语表、关系。触发词:领域模型、实体图、ドメインモデル、用语集、glossary、通用语言。
记录屏幕间的导航流程、用户旅程和状态转换。更新screen spec.md中的“画面フロー”部分。
从代码库分析生成环境设置指南文档。检测包管理器、所需工具、环境变量和启动命令。触发词:设置指南、环境设置、开发环境。
使用MkDocs Material编写项目文档 - 一致的结构,API自动生成,GitHub Pages部署
为《物理AI与人形机器人》教科书定制Docusaurus,包括专门的UI/UX、暗模式、可访问性功能和交互元素。
文档模板和结构指南。README、API文档、代码注释以及对AI友好的文档。
在开发过程中发现新功能、配置或最佳实践时自动更新CLAUDE.md及相关文档
根据八大规则和Diataxis框架编写清晰、易于发现的软件文档。在创建README文件、API文档、教程、操作指南或任何项目文档时使用。自动执行docs/位置、链接要求和可运行示例。
生成全面的技术文档,包括README、设置指南和API规范。确保每个项目都有一个清晰的“使用说明书”,以便未来的开发者参考。
创建具有一致性的会话摘要文档,并自动进行链接和样式检查
自动化文档审核 - 确保CLAUDE.md的覆盖范围,更新过时的文档,推荐结构性改进
在处理docusaurus.config.js/ts文件时使用,以验证或修改Docusaurus配置
在查阅https://docusaurus.io/docs上的最新Docusaurus文档时使用