readme
You are an expert technical writer creating comprehensive project documentation. Your goal is to write a README.md that is absurdly thorough—the kin…
它会碰到什么
逐条看命中(6 条严重或高危)
- 严重
references/detailed-guide.md:29cred-paths- .env.example, .env.sample, or documented environment variables
- 严重
references/detailed-guide.md:29cred-paths- .env.example, .env.sample, or documented environment variables
- 严重
references/detailed-guide.md:31cred-paths- Credentials setup (config/credentials.yml.enc, config/master.key)
- 严重
references/detailed-guide.md:168cred-pathscp .env.example .env
- 严重
references/detailed-guide.md:168cred-pathscp .env.example .env
- 严重
references/detailed-guide.md:756cred-paths2. Or regenerate credentials: `rm config/credentials.yml.enc && bin/rails credentials:edit`
这一栏是扫描器报的事实,不是结论。命中多不等于有毒(安全工具、规则库、示例脚本本来就会包含危险写法),命中少也不等于干净。它和你手上的凭据、文件、网络有什么关系,需要你自己看。
技能内容
README Generator
You are an expert technical writer creating comprehensive project documentation. Your goal is to write a README.md that is absurdly thorough—the kind of documentation you wish every project had.
Detailed Guide
Read [the detailed guide](references/detailed-guide.md) before executing this skill. It retains the complete procedure and reference material. Treat its safety, prerequisites, and validation requirements as mandatory. For focused work, load the relevant sections; for end-to-end work, read the guide completely.
When to Use This Skill
Use this skill when:
- User wants to create or update a README.md file
- User says "write readme" or "create readme"
- User asks to "document this project"
- User requests "project documentation"
- User asks for help with README.md
Limitations
- Use this skill only when the task clearly matches the scope described above.
- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.
想直接用这个技能?
本站把开放许可(MIT / Apache 等)的技能按仓库打包整理到网盘,点一下转存到你自己的网盘,不用一个个从 GitHub 拉。许可未声明的技能只给原始仓库链接,不打包。
同名技能的其他版本
有 3 个不同仓库或目录里都有叫 readme 的技能。它们内容并不相同,别混用:
- sickn33/agentic-awesome-skills — You are an expert technical writer creating comprehensive project documentation. Your goal
- sickn33/agentic-awesome-skills — You are an expert technical writer creating comprehensive project documentation. Your goal