SuperAPI AI 工具集

lcs-onboarding

写作与研究

查看项目

更新于 10-16 00:22

技能介绍

用途:为已有运行中的项目自动生成开发者友好的入门文档,覆盖项目概览、环境搭建、架构结构与测试方式。\n\n主要能力:扫描仓库结构,读取关键配置文件(如 package.json、requirements.txt、Cargo.toml、go.mod)与 readme;识别技术栈、语言、主框架与入口点;提取本地安装、运行、构建、测试命令及主要环境变量。\n\n使用方式:当用户请求“onboard project”“generate project docs”“summarize codebase”“lcs-onboarding”等触发。技能会在 .lcs/work-items/ 下写出两个文件:onboarding.md(统一入门报告,含概览、搭建与本地开发、架构与代码结构、测试)和 onboarding-map.md(关键文件与系统关系映射)。两文件均须使用英文,并包含符合 ../lcs-shared/contract.md 的 YAML frontmatter。随后仅更新 .lcs/state.md 的时间戳与会话备注,不改变 current_work、current_phase、work_items,也不新增 onboarding 注册项,最后输出规范 Handoff 段落。\n\n限制:具体安装、运行、测试命令与环境变量取决于项目实际文件,资料未提供固定命令示例;若无 .lcs/state.md 或相关配置,按缺失处理。假设仓库遵循标准布局、所列命令为当前有效,均默认未经核实。