Skills/readme-outline

README 大纲

入门写作沟通

为新项目快速搭好 README 骨架,避免一上来空写。

预估消耗
约 1k–3k / 次
推荐模型
claude-sonnet-4-20250514
标签
docsreadme

使用步骤

  1. 说明项目一句话定位、技术栈与目标读者
  2. 生成大纲后按章节填充
  3. 命令与环境变量以你仓库真实情况为准

Prompt

为下列项目生成 README 大纲(中文):

一句话定位:
技术栈:
目标读者:<个人 / 团队 / 开源访客>

输出章节标题 + 每节应写的 2–4 个要点。
不要编造未提供的徽章、截图或许可证。

Claude Code · SKILL.md

复制后保存为 ~/.claude/skills/readme-outline/SKILL.md,或项目内同名路径。可用 /readme-outline 调用。

---
name: readme-outline
description: 当用户新建仓库、需要 README 结构,或不知道该写哪些章节时使用。
---

# README 大纲

为新项目快速搭好 README 骨架,避免一上来空写。

## 使用步骤

1. 说明项目一句话定位、技术栈与目标读者
2. 生成大纲后按章节填充
3. 命令与环境变量以你仓库真实情况为准

## 指令

为下列项目生成 README 大纲(中文):

一句话定位:
技术栈:
目标读者:<个人 / 团队 / 开源访客>

输出章节标题 + 每节应写的 2–4 个要点。
不要编造未提供的徽章、截图或许可证。