SuperAPI AI 工具集

docmap

写作与研究

查看项目

更新于 10-16 03:15

技能介绍

用途:docmap 约定所有项目文档放在 docs/ 目录,并通过 docmap CLI 在终端中浏览和阅读,方便人类与 AI 智能体发现文档。

主要能力:CLI 按位置参数处理目标,自动判断类型(目录则列出,文件则读取),可一次传入多个目标;列表中的根前缀(默认 docs/)在输入时可省略。支持递归列出、校验文件,读取文档时会剥离 frontmatter。

用法示例: docmap 列出根文档; docmap topic-a topic-b/sub-topic-c 列出子目录; docmap --recursive 列出全部; docmap doc-1.md docs/topic-a/doc-2.md 读取文档; docmap topic-a docs/topic-a/doc-1.md 混合列出与读取; docmap --check 校验所有文件。命令通过项目包管理器运行,如 npm run docmap --、pnpm docmap、yarn docmap。

写作约定:面向技术能力强但不熟悉本项目的读者;简洁具体,典型文档 40–80 行;优先引用源文件而非大段代码;标题已说明用途时省略摘要。文件名与目录用小写加连字符(kebab-case),允许大写如 RELEASING.md,名称须 shell 安全(无空格、引号、特殊字符),统一用 .md,相关文档放入可嵌套的子目录。

YAML frontmatter 可选,字段包括 title(列表显示名,缺省回退到首个 # 标题)、summary(一句话,标题已明确时可省略)、read_when(动作导向提示列表,补全“当你……时阅读本文档”)。frontmatter 之后为普通 Markdown,正文格式无限制。

限制:资料未提供安装方式、具体平台支持、收费或价格信息;CLI 校验仅覆盖命名等约定,具体校验范围暂未提供。