- Home
- Skills
- Technical Documentation
- opensource-doc-generator
Opensource Doc Generator
Automated generation of standardized open-source documentation based on deep project structure analysis.
Free
Works with the AI Agents you already use
opensource-doc-generator
Example session with this skill installed
Help me prepare my Node.js project for GitHub. I need a standard documentation set.
- Read your context and instructions
- Compiled the opensource-doc-generator
I have analyzed your project and identified a Node.js/TypeScript stack with Jest for testing.
Project Analysis Summary
- Name: agensi-sdk-core
- Tech Stack: Node.js, TypeScript, Jest
- Type: Library/Framework
- Status: Lacks README, LICENSE, and contribution guides.
Recommended Documentation Plans
| Tier | Included Files | Best For |
|---|---|---|
| Tier 1: Full Suite | README, LICENSE, .gitignore, CONTRIBUTING, CODE_OF_CONDUCT, CHANGELOG, .editorconfig, Issue/PR Templates | Serious open-source projects seeking community contributors. |
| Tier 2: Standard | README, LICENSE, .gitignore, CONTRIBUTING, CHANGELOG, .editorconfig | Small team or individual projects needing professional polish. |
| Tier 3: Basic | README, LICENSE, .gitignore | Prototypes or personal tools. |
Questions for you:
- Which tier would you like to generate?
- Which license would you prefer? (MIT is recommended for libraries)
- Should I include a GitHub Actions workflow for your Jest tests?
Next steps
- Reply with your chosen Tier (e.g., "Tier 2").
- Confirm the LICENSE type (e.g., "MIT").
- Provide the Author name for the LICENSE file.
Connects securely to your tools. The creator never sees your data.
About this skill
Developers often neglect the crucial final step of a project: documentation. Without a proper README, LICENSE, or CONTRIBUTING guide, open-source projects fail to gain traction or face legal ambiguity. This skill automates the entire documentation suite by analyzing your codebase and generating standardized files tailored to your specific tech stack.
What it does
- Project analysis scans configuration files like
package.json,go.mod, orCargo.tomlto identify tech stacks and project scope. - Tiered recommendations provides four levels of documentation depth, from "Basic" (3 files) to "Full Suite" (10+ files).
- Template generation builds 20+ document types including README, LICENSE, SECURITY.md, and GitHub Issue/PR templates.
- Dependency recognition automatically generates appropriate
.gitignoreand.editorconfigfiles based on identified languages. - Legal compliance helps select and populate licenses like MIT, Apache-2.0, or GPL-3.0 based on project needs.
How it works
- Trigger the skill when your project is ready for release or lacks standard documentation.
- Review the project summary and choose one of the four recommended documentation tiers.
- Provide specific details when prompted, such as preferred license type and author information.
- Execute the generation to receive the full set of Markdown files ready for your repository.
Frameworks & tools
Supports all major ecosystems including Node.js, Python, Go, Rust, Java, C#, and C++. It handles GitHub-specific configurations like Actions workflows and community health files.
Why this beats prompting it yourself
Generic prompts often result in empty templates or hallucinated installation steps. This skill cross-references your actual entry points, dependency files, and directory structure to ensure the generated commands and descriptions match your real code.
Use cases
- Preparing a private repository for public open-source release on GitHub or GitLab.
- Standardizing documentation across a microservices architecture with multiple small repos.
- Bootstrapping community governance files for projects seeking outside contributors.
- Generating specific files like
CITATION.cfffor academic software orSECURITY.mdfor enterprise tools.
Known limitations
Does not perform deep logic analysis of code; relies on configuration files and directory structures. Requires user input for licensing and author details if not found in metadata.
Requires metadata files (package.json, etc.) for accurate tech stack detection. Does not write deep technical architecture details or internal logic documentation.
How to use
- 1
Connect your agent to the Agensi MCP
Copy the prompt and paste it into Claude, ChatGPT, Cursor or any agent that supports MCP. It sets up the connection for you. Manual setup
- 2
Sign in to Agensi
Your agent shows a sign-in link. Sign in and click Allow.
- 3
Ask for what you need
Your agent loads this skill and uses it on your task. It always asks before any payment.
Reviews
No reviews yet
Be one of the first to try it. Every listed skill goes through the trust checks below.
Security scanned
Checked by our 8-point scan before listing
Fresh listing
Recently published to Agensi
Free forever
No account required to browse
Trust & safety
Security scan
Security scan passed 22 days ago
- Free with an Agensi account
Requires
Permissions
Allowed Hosts