docs-creating-by-example-tutorials
创建示例教程的全面指南 - 以代码为主的教学路径,包含75-90个重注释示例,达到95%的语言覆盖。涵盖五部分示例结构、注释密度标准(每个示例每行代码1-2.25条评论)、自包含规则以及用于比较的多个代码块。对于在教育平台上为编程语言创建基于示例的教程至关重要。
把 Skill 的源码、资源快照、README、包体和安装信号放进一个可搜索、可筛选的公开目录。
创建示例教程的全面指南 - 以代码为主的教学路径,包含75-90个重注释示例,达到95%的语言覆盖。涵盖五部分示例结构、注释密度标准(每个示例每行代码1-2.25条评论)、自包含规则以及用于比较的多个代码块。对于在教育平台上为编程语言创建基于示例的教程至关重要。
根据设计文档生成一级(README.md)用户文档。在为npm/GitHub创建或更新包README文件时使用。
获取最新的库文档直接进入上下文,以防止出现幻觉API和过时的代码示例。当用户说“使用文档”、“获取[库]的文档”、“检查[库]的文档”,或询问某个库的API、方法、使用模式,并且当前文档会有帮助时使用。在为那些版本特定准确性很重要的库生成代码时,也应主动使用。
编排完整的单文档工作流程,在写入→验证→索引的流水线中自动进行验证和索引
docsca 创建 summary.md 并更新必要的全局文档的步骤。
從專案來源產生使用說明文件。 使用時機:「產生文件」、「建立速查表」、「使用指南」、「功能參考」、「列出所有功能」 關鍵字:documentation, usage, reference, cheatsheet, features, 功能文件, 速查表, 使用說明
docs.cloudposse.com 的 CSS 样式、颜色主题和视觉规范。在设置组件样式、mermaid 图表或处理站点主题时使用。
完成SDLC文档的CRUD(故事、任务、上下文检索)。在创建/管理故事、创建/管理任务、更新任务状态或通过索引为任何用户故事检索完整上下文时使用(<3分钟恢复)。
导出Google Docs。可以通过“将Docs另存为PDF”、“导出文档”、“下载Docs”、“将文档另存为PDF”、“保存为Word”等方式启动。
通过context7和网络搜索发现技术文档。功能:查找库/框架文档,主题特定搜索。关键词:llms.txt, context7, 文档, 库文档, API文档。使用时机:搜索库文档时,寻找框架指南时,查找API参考时。
按领域划分的通用参考文档。在创建架构文档、策略文档、规范或指南时使用。
激活技术撰稿人生成、更新或重构内部项目文档。在创建README、ADR或技术指南时使用。
在向React文档中添加交互式代码示例时使用。
使用可执行脚本搜索技术文档,以检测查询类型,从llms.txt来源(context7.com)获取,并分析结果。当用户需要以下内容时使用:(1) 特定主题的文档(特性/组件/概念),(2) 库/框架文档,(3) GitHub仓库分析,(4) 使用自动化代理分发策略进行文档发现
为开源和内部项目生成全面的文档模板,包括README、CONTRIBUTING、SECURITY、CODE_OF_CONDUCT、LICENSE以及其他标准文档,并提供建议部分和最佳实践。当用户请求“创建项目文档”、“添加OSS文档”、“设置标准文档”或“使其准备好开源”时使用。
从Betty框架注册表自动生成README.md
根据设计文档生成二级(仓库文档)。在以下情况下使用
引导用户通过结构化的共同创作、改进和文档质量检查。当用户想要编写或改进诸如提案、技术规范、决策文件、README、指南、API文档或运行手册等文档时使用;或者当他们要求进行文档审查、文档质量检查、检查清单或模板以使文档对读者更清晰、易于浏览和正确时使用。
获取Google Docs的列表。可以通过“文档列表”、“Docs列表”、“Google Docs列表”、“想看Docs”、“文档”等方式启动。
为文档页面编写YAML前导内容,包含适合社交媒体卡片展示的标题和描述。
审查文档更改是否符合Metabase写作风格指南。在审查包含文档markdown文件的拉取请求、文件或差异时使用。
通过使用llms.txt标准在互联网上搜索技术文档,利用Repomix浏览GitHub仓库,并进行并行探索。当用户需要以下内容时使用:(1)库/框架的最新文档,(2)llms.txt格式的文档,(3)GitHub仓库分析,(4)没有直接llms.txt支持的文档,(5)并行的多个文档来源
更新文档的标准程序
保持文档与代码更改同步,包括README、文档站点、API文档、运行手册和配置。当用户要求更新文档时使用,确保文档与行为一致,或为发布/PR准备文档。