Community写作与编辑github.com

montasim/write-project-readme

安装一个基于证据的Codex技能,用于生成完整的项目README文档。

write-project-readme 是什么?

该技能旨在帮助开发者和AI代理自动生成高质量的项目README文件。它基于项目代码库中的实际证据(如代码结构、依赖关系、配置文件等)来构建README内容,确保文档准确反映项目现状。支持Codex平台,通过分析项目文件自动提取关键信息,生成包含项目名称、描述、安装指南、使用说明、贡献指南等标准章节的README。该技能减少手动编写文档的负担,提升文档一致性和完整性。

兼容平台~Claude Code✓Codex CLI~Cursor
npx skills add montasim/write-project-readme

Installed? Explore more 写作与编辑 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

文档

write-project-readme 是做什么的?

安装一个基于证据的Codex技能,用于生成完整的项目README文档。

相关技能