Molili项目文档自动生成技能教程

开发者可以利用Molili自动扫描项目目录、读取配置文件并分析现有代码,从而快速生成包含安装方法、使用说明、API文档及开发指南等标准结构的README文件。以下是关于Molili自动生成README文档的配置与使用指南。

一、安装与配置方法

和之前的教程一样,直接把下面的内容跟Molili让它来安装

mkdir -p ~/.molili/active_skills/gen-readme

cat > ~/.molili/active_skills/gen-readme/SKILL.md << 'EOF'
---
name: gen-readme
description: 为项目自动生成 README 文档
---

你是一位技术文档专家。

## 工作流程

1. 分析项目
   - 扫描项目目录结构
   - 查看 package.json 或其他配置文件
   - 阅读现有代码

2. 生成内容
   - 项目简介
   - 安装方法
   - 使用说明
   - API 文档
   - 开发指南

3. 格式化
   - 使用清晰的章节结构
   - 添加代码示例
   - 添加适当的徽章
   - 添加许可证信息

## 标准 README 结构

- 项目标题和简介
- 功能特点
- 安装方法
- 快速开始
- 使用说明
- API 文档
- 开发指南
- 贡献指南
- 许可证
EOF

(注:执行完毕后,重启Molili即可使该技能生效)

二、功能实测与常用指令

配置完成后,Molili会按照设定的工作流(分析项目、生成内容、格式化)执行任务,并输出符合标准结构的文档。

1. 唤醒并生成完整文档:
在Molili的对话框中直接输入以下指令:

/gen-readme 请根据当前项目结构生成一份完整的 README 文档

2. 针对特定模块生成或补充:
可以在指令中明确侧重点,例如补充具体的开发指南:

/gen-readme 为当前项目生成 README,请重点完善“API 文档”和“快速开始”部分的代码示例

完成上述配置后,Molili即可接管基础的项目文档编写工作,开发者能快速搭建清晰规范的文档框架,减少手动梳理项目结构和排版的时间。按上文步骤设置后,即可在本地开发环境中直接调用。

开发必备

项目文档自动生成省时

文档自动生成这个技能太实用了,以前写项目文档要花一天,现在半小时搞定

生成的文档质量还行,但格式模板太少了,能不能支持自定义模板?

技术文档生成效果不错,但API文档的参数说明经常漏字段,还是要人工校验

独立开发者表示这个技能是救星,一个人写代码还要写文档真的要命

文档自动生成最大的问题是格式不统一 每次生成出来的结构都不太一样 需要手动调模板

@fldev API文档漏字段是因为AI只能从代码推断参数 没有注释或类型声明的动态语言项目漏得特别多 TypeScript项目的生成质量明显高于纯JavaScript

@tpeco 自定义模板可以通过SOUL.md配置 在里面写清楚’所有文档必须包含XX章节 使用XX格式’ AI就会按你的模板走