用途:为项目中的技术主题编写快速参考指南,回答“X 在本项目哪里”“Y 需要哪些命令”“何时用 A 而非 B”“完整文档在哪”等问题。目标读者是有经验的开发者,目标是速查而非完整教程;篇幅目标 50-100 行,绝对上限 150 行。
主要能力:常见主题包括配置模式、认证与授权、数据库操作、API 约定、测试模式、Git 工作流、部署流程。写作前先确定主题,再检索代码库中的真实配置文件与位置、当前使用的模式、可引用的实际示例和既有约定,只引用真实文件而非假设示例;如有范围或主题上的疑问,先向用户澄清。
建议结构:快速概览(2-3 句,说明使用的技术/模式、原因、相关加载顺序);“东西在哪里”(项目路径树);快速开始(3-5 个最常用命令/模式);速查表(任务、命令/模式、使用场景三列表格);常见路径(配置、新增内容位置);最佳实践(5-7 条,说明何时用 X、避免 Z 的原因、项目特定约定);文档(官方文档与相关指南链接)。
格式与语气:比较用表格、列表用项目符号、命令用代码块、关键术语加粗;语气直接,写“生成配置:rails g config name”而非冗长描述;引用真实文件,如“参见 config/configs/ 中的 CoreConfig”。
包含与排除:包含项目特定路径与约定、速查表、覆盖 80% 场景的常用命令、完整文档链接、真实文件引用;排除完整教程、过度细节、长代码示例(改为指向实际文件)、开发者早已知晓的内容和重复内容。
限制:官方资料未提供具体收费、价格、平台支持或效果信息;本介绍仅依据技能说明整理,实际主题与内容范围需在使用时由用户确定。