该技能用于技术文档写作,适用场景包括:撰写 README、编写算法讲解、记录系统设计方案、写面试准备指南、制作速查表与参考资料、补充代码文档。
主要能力是提供一套文档写作规范。结构方面:doc/cheatsheet/ 与 doc/faq/ 之外的文档通常包含清晰的 H1 标题、一段描述,以及不跳级的章节层级;并提供含目录、分节与参考链接的标准模板。算法文档格式包含题号与标题、难度、主题、公司标签、题目描述与示例、约束、思路与算法步骤、复杂度分析、多语言代码实现(如 Java、Python 代码块)、替代方案与对比表、要点总结与相关题目。系统设计文档格式包含需求(功能与非功能)、容量估算(流量、存储、带宽)、API 设计、高层架构、数据库设计与建表 SQL、索引策略、组件详细设计、可扩展性与可靠性(缓存、分片、复制)、权衡与备选方案、监控告警、安全考量与参考。
其他规范:行内代码用反引号,代码块用带语言的围栏,支持 java、python、javascript、sql、bash、json、yaml、xml、markdown、c、cpp、scala、go;支持表格、有序与无序列表、强调、链接与图片语法;复杂度分析给出标准写法与常见复杂度速查表;写作风格要求清晰、简洁、一致,使用主动语态、避免不必要术语;面试准备文档采用模式模板;速查表保持可扫读。
项目内约定:速查表放在 doc/cheatsheet/ 并使用 /lc-cheatsheet;FAQ 放在 doc/faq/ 并使用 /lc-faq-add;系统设计文档遵循 system_design/00_template.md。文档维护建议用 git 跟踪变更、维护交叉引用并检查链接与代码示例,定稿前使用质量清单核对。
限制:资料未提供该技能的安装命令、运行方式、依赖环境、平台支持或收费信息。