【研发类-开发方法论Skills】c4-code 技能

专家级C4代码级文档专家。分析代码目录以创建全面的C4代码级文档包括函数签名、参数、依赖关系和代码结构。技能概述c4-code 技能是一个专门用于创建C4代码级文档的技能。它能够深入分析代码目录生成全面的文档包括函数签名、参数、依赖关系和代码结构。该技能支持面向对象、函数式和过程式编程范式能够生成清晰的Mermaid图表来展示代码关系。下载地址agentic-awesome-skills/skills/c4-code at main · sickn33/agentic-awesome-skills · GitHub主要功能代码元素文档记录函数/方法签名、参数和返回类型类/模块分析分析类和模块的结构、方法和依赖关系依赖关系映射识别和记录内部和外部依赖关系图表生成生成Mermaid图表展示代码结构和关系多范式支持支持面向对象、函数式和过程式代码触发条件在以下情况下应该调用此技能处理C4代码级任务或工作流时需要C4代码级的指导、最佳实践或检查清单时需要分析代码目录并创建详细文档时需要记录函数签名、参数和依赖关系时不适用场景不适用情况任务与C4代码级无关时需要此范围之外的不同域或工具时处理过程1. 明确目标明确目标、约束条件和所需的输入确保理解文档需求。2. 分析代码深入分析代码目录识别函数、类、模块和依赖关系。3. 应用最佳实践应用相关的最佳实践并验证结果确保文档质量。4. 生成文档提供可操作的步骤和验证生成结构化的C4代码级文档。文档结构代码元素函数/方法签名、描述、位置、依赖关系类/模块描述、位置、方法、依赖关系依赖关系内部依赖项目内的代码依赖外部依赖外部库、框架、服务图表类型面向对象代码使用classDiagram展示类、接口和继承关系函数式/过程式代码使用flowchart展示数据流和函数管道模块结构使用classDiagram with module展示模块结构示例交互面向对象代码库分析src/api目录并创建C4代码级文档记录服务层代码包括完整的类层次结构和依赖关系创建C4代码文档展示存储库层中的接口实现函数式/过程式代码库记录认证模块中的所有函数及其签名和数据流为src/pipeline中的ETL转换器创建数据管道图分析utils目录并记录所有纯函数及其组合模式关键区别vs C4-Component agent专注于单个代码元素Component agent将多个代码文件合成为组件vs C4-Container agent记录代码结构Container agent将组件映射到部署单元vs C4-Context agent提供代码级细节Context agent创建高级系统图输入要求使用此技能时用户需要提供要分析的代码目录路径文档的目标和范围编程语言和范式信息特定的文档需求输出说明技能将提供完整的函数/方法签名及所有参数和返回类型每个代码元素的清晰描述指向实际源代码位置的链接完整的依赖列表内部和外部遵循C4代码级模板的结构化文档复杂代码关系的Mermaid图表如需要最佳实践明确范围明确要文档化的代码目录和范围选择合适的图表根据编程范式选择合适的图表类型保持一致性在所有代码文档中保持一致的命名和格式记录依赖完整记录所有内部和外部依赖提供链接提供指向实际源代码位置的链接局限性仅当任务明确符合上述范围时使用此技能不要将输出作为环境特定验证、测试或专家审查的替代品如果缺少所需的输入、权限、安全边界或成功标准请停止并寻求澄清