المهارات readme
📦

readme

آمن

生成全面的 README 文档

此技能为任何项目创建完整的 README.md 文档，涵盖设置、架构、部署和故障排除。非常适合希望无需手动编写即可获得完整项目文档的开发者。

يدعم: Claude Codex Code(CC)
⚠️ 66 ضعيف
1

تنزيل ZIP المهارة

2

رفع في Claude

اذهب إلى Settings → Capabilities → Skills → Upload skill

3

فعّل وابدأ الاستخدام

اختبرها

استخدام "readme". Create a README for my Rails app

النتيجة المتوقعة:

生成全面的 README，包含：项目标题和概述、技术栈表、先决条件、分步入门指南、目录结构说明、数据库架构、环境变量参考、可用脚本、测试说明、检测到的平台的部署指南、故障排除部分

استخدام "readme". Document my Node.js project

النتيجة المتوقعة:

创建包含以下内容的 README：项目描述、依赖项、设置说明、npm 脚本参考、环境配置、架构概述、检测到的平台（Vercel、Render 等）的��署说明、常见故障排除步骤

التدقيق الأمني

آمن
v1 • 2/24/2026

All 268 static findings are FALSE POSITIVES. This is a documentation generation skill that provides instructions for writing README files. The flagged patterns (external commands, environment variables, URLs) are all example content within the documentation templates, not actual code execution or credential access. No real security risks identified.

1
الملفات التي تم فحصها
843
الأسطر التي تم تحليلها
5
النتائج
1
إجمالي عمليات التدقيق

مشكلات عالية المخاطر (5)

SKILL.md:75-842
External Commands False Positive
Static scanner flagged 208 instances of 'external_commands' (Ruby/shell backtick execution) - these are example commands in documentation templates, not actual code execution. The skill generates README documentation and does not execute any commands.
SKILL.md:190-633
Environment Access False Positive
Static scanner flagged 16 instances of 'env_access' (DATABASE_URL, SECRET_KEY_BASE, etc.) - these are documented environment variables in example documentation, not actual environment access.
SKILL.md:4-377
Network Access False Positive
Static scanner flagged 6 instances of 'network' (URLs, SMTP settings) - these are example URLs and configuration documentation, not actual network requests.
SKILL.md:45-770
Sensitive Files False Positive
Static scanner flagged references to credentials files (.env.example, credentials.yml.enc, master.key) - these are documentation about configuration files, not actual file access.
SKILL.md:3-555
Weak Cryptographic Algorithm False Positive
Static scanner flagged 10 instances of 'weak cryptographic algorithm' - these are standard Rails terms (encrypted_password, credentials.yml.enc) in documentation, not actual crypto implementation.
تم تدقيقه بواسطة: claude

درجة الجودة

38
الهندسة المعمارية
100
قابلية الصيانة
87
المحتوى
50
المجتمع
55
الأمان
91
الامتثال للمواصفات

ماذا يمكنك بناءه

新项目文档

为新创建的项目生成完整的 README，从第一天开始记录设置和架构。

旧项目 README 更新

使用当前的设置说明、架构详细信息和部署步骤更新过时的 README 文件。

开源项目增强

为开源项目创建详尽的文档，以改善贡献者的入门体验。

جرّب هذه الموجهات

基本 README 生成 
使用 readme 技能为此项目创建 README.md。首先探索代码库以了解结构。
更新现有 README 
使用更详尽的文档更新现有的 README.md。当前的 README 已过时且缺少关键部分。
添加部署部分 
为我们的 README 添加部署部分。检查部署配置文件，如 Dockerfile、docker-compose.yml 或部署配置。
完整文档改造 
创建一个极其详尽的 README，涵盖所有内容：本地设置、架构深入剖析、环境变量、测试、部署和故障排除。

أفضل الممارسات

  • 让技能在生成文档之前完全探索代码库以获得准确的内容
  • 提供所有配置文件（.env.example、database.yml 等）的访问权限以获得完整的文档
  • 审查生成的环境变量表并添加任何缺失的敏感值

تجنب

  • 不要在未先授予文件访问权限的情况下要求技能记录项目
  • 避免中断探索阶段 - 让它收集所有项目详细信息
  • 不要期望技能知道代码中不明显的业务逻辑

الأسئلة المتكررة

此技能支持哪些框架？
此技能适用于任何框架。它通过检查项目文件来检测 Ruby/Rails、Node.js、Python、Go 等。然后相应地定制文档。
它适用于 monorepos 吗？
该技能可以记录 monorepos，但可能需要有关关注哪些包或服务的指导。提供有关项目结构的上下文。
它可以更新现有的 README 吗？
是的。该技能可以读取现有的 README 并使用缺失的部分进行增强，或者使用更详尽的内容完全重写它。
它检测哪些部署平台？
它检测 Docker、Kamal、Heroku、Fly.io、Render、Vercel、Netlify、AWS Elastic Beanstalk、Serverless、Kubernetes 和通用 VPS 部署。
生成的文档有多详尽？
目标是"极其详尽"的文档。它包括设置、架构、环境变量、脚本、测试、部署和故障排除部分。
此技能执行任何命令吗？
不。这是一个文档生成技能。它只读取文件以了解项目并生成 markdown 文档。它不运行任何命令。

تفاصيل المطور

المؤلف

sickn33

الترخيص

MIT

المستودع

https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/readme

مرجع

main

بنية الملفات

📄 SKILL.md