Documentation Readme
Generates a detailed README file based on provided project data and parameters.
Install
$ agentstack add skill-ucdavis-ai-skills-registry-documentation-readme ✓ scanned · ✓ verified, works with Claude Code, Cursor, and more.
Security review
✓ PassedNo issues found. Passed automated security review. · v0.1.0 How review works →
- ✓ Prompt-injection patterns
- ✓ Secret / credential exfiltration
- ✓ Dangerous shell & filesystem operations
- ✓ Untrusted network calls
- ✓ Known-malicious package signatures
What it can access
- ✓ Network access No
- ✓ Filesystem access No
- ✓ Shell / process execution No
- ✓ Environment & secrets No
- ✓ Dynamic code execution No
From automated source analysis of v0.1.0. “Used” means the capability is present in the source — more access means more to trust, not that it’s unsafe.
Verified badge
Passed review? Show it. Paste this badge into your README, it links to the public security report.
Links to your public security report.[](https://agentstack.voostack.com/security/report/skill-ucdavis-ai-skills-registry-documentation-readme) Reliability & compatibility
Declared compatibility
Compatibility is declared by the source manifest. End-to-end runtime verification is coming, see below.
We're building live execution health for every listing: tool-call success rate, median latency, uptime, and last-checked timestamps, measured, not self-reported. It isn't live yet, so we don't show numbers we can't stand behind.
How agent discovery & health will work →About
README Generation Skill
Generate a comprehensive README file for this software project or update the existing one if it exists. The maintainer is Simon Dvorak
When to Use This Skill
Use this skill when you need to create or update a README file that provides clear and structured information about the project, its purpose, installation instructions, usage, and other relevant details.
Instructions
Create a README file for the project based on the provided project details, codebase information, and any other relevant context.
The README should include the following sections to ensure it is thorough and user-friendly:
- Project Title: Clearly state the name of the project.
- Description: Provide a concise overview of the project, its purpose, and key features.
- Installation Instructions: Step-by-step guide on how to install and set up the project.
- Usage: Examples and explanations of how to use the project.
- Configuration: Details about any configuration options or environment variables required.
- Dependencies: List any external libraries, frameworks, or tools the project relies on.
- Contact Information: How users or contributors can reach the maintainers.
If any relevant project details or codebase information are provided, incorporate them accurately into the README.
Output Format
The output should be a markdown-formatted text file suitable for use as a README.md file in the root directory of the project.
Notes
- If specific project details are missing, generate generic placeholders that can be customized later.
- Ensure clarity, proper formatting, and consistent style throughout the README.
Source & license
This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.
- Author: ucdavis
- Source: ucdavis/ai-skills-registry
- License: MIT
Install and usage instructions live in the source repository linked above.
Reviews
No reviews yet, be the first.
Write a review
Versions
- v0.1.0 Imported from the upstream source.