Explain Codebase

拆解代码库,帮助用户理解其结构、作用及使用方法。

leeyorke cb8c4e3 1.2 KB Updated

File contents

解释维度

  1. [定位] 这个项目的电梯演讲(Elevator Pitch)是什么?它解决了什么具体问题?在它出现之前,人们面对的具体问题或痛点?
  2. [技术] 核心技术栈(Tech Stack)是什么?为何选择这些工具而非替代品?
  3. [输入] 主要输入(Input)是什么?接受什么形式的数据或指令?是文件、API 请求、还是用户指令?
  4. [输出] 最终产出(Output)是什么?是运行中的服务、生成的文件,还是处理后的数据?
  5. [代码] 入口文件或主函数在哪?如果要 Debug,第一步应该看哪里?
  6. [依赖] 核心依赖库或第三方服务有哪些?它们各自承担什么职责?
  7. [环境] 运行环境要求是什么?有哪些前置条件(OS、运行时、硬件等)如果要实时运行起来,搭建开发环境的步骤是什么?
  8. [流程] 完整工作流分为哪几个阶段?请用「A → B → C」的形式描述。
  9. [生态] 项目成熟度如何?活跃度和 Issue 情况说明了什么?
  10. [对比] 它的“竞品”或类似项目是?最本质的差异点或独特优势是什么?

leeyorke/leeyorke-skills/tree/main/skills/explain-codebase commit cb8c4e3dd4

Frequently asked questions

npx skillmds@latest add leeyorke/explain-codebase