Stats
Actions
Tags
Help us improve
Share bugs, ideas, or general feedback.
From antigravity-bundle-oss-maintainer
Provides Markdown templates and guidelines for READMEs, API docs, JSDoc/TSDoc comments, changelogs, ADRs, and AI-friendly formats like llms.txt. Use for structuring project documentation.
npx claudepluginhub sickn33/antigravity-awesome-skills --plugin antigravity-bundle-oss-maintainerHow this skill is triggered — by the user, by Claude, or both
Slash command
/antigravity-bundle-oss-maintainer:documentation-templatesThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
> Templates and structure guidelines for common documentation types.
Provides Markdown templates and guidelines for READMEs, API docs, JSDoc/TSDoc comments, changelogs, ADRs, and AI-friendly formats like llms.txt. Use for structuring project documentation.
Provides templates and patterns for READMEs, ADRs, OpenAPI 3.1 API docs, changelogs, and technical writing styles. Use for project documentation, architecture decisions, API specs, and release notes.
Generates or updates documentation for code, APIs, or systems including READMEs, API references, inline comments, technical guides, and ADRs.
Share bugs, ideas, or general feedback.
Templates and structure guidelines for common documentation types.
| Section | Purpose |
|---|---|
| Title + One-liner | What is this? |
| Quick Start | Running in <5 min |
| Features | What can I do? |
| Configuration | How to customize |
| API Reference | Link to detailed docs |
| Contributing | How to help |
| License | Legal |
# Project Name
Brief one-line description.
## Quick Start
[Minimum steps to run]
## Features
- Feature 1
- Feature 2
## Configuration
| Variable | Description | Default |
|----------|-------------|---------|
| PORT | Server port | 3000 |
## Documentation
- API Reference
- Architecture
## License
MIT
## GET /users/:id
Get a user by ID.
**Parameters:**
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | string | Yes | User ID |
**Response:**
- 200: User object
- 404: User not found
**Example:**
[Request and response example]
/**
* Brief description of what the function does.
*
* @param paramName - Description of parameter
* @returns Description of return value
* @throws ErrorType - When this error occurs
*
* @example
* const result = functionName(input);
*/
| ✅ Comment | ❌ Don't Comment |
|---|---|
| Why (business logic) | What (obvious) |
| Complex algorithms | Every line |
| Non-obvious behavior | Self-explanatory code |
| API contracts | Implementation details |
# Changelog
## [Unreleased]
### Added
- New feature
## [1.0.0] - 2025-01-01
### Added
- Initial release
### Changed
- Updated dependency
### Fixed
- Bug fix
# ADR-001: [Title]
## Status
Accepted / Deprecated / Superseded
## Context
Why are we making this decision?
## Decision
What did we decide?
## Consequences
What are the trade-offs?
For AI crawlers and agents:
# Project Name
> One-line objective.
## Core Files
- [src/index.ts]: Main entry
- [src/api/]: API routes
- [docs/]: Documentation
## Key Concepts
- Concept 1: Brief explanation
- Concept 2: Brief explanation
For RAG indexing:
| Principle | Why |
|---|---|
| Scannable | Headers, lists, tables |
| Examples first | Show, don't just tell |
| Progressive detail | Simple → Complex |
| Up to date | Outdated = misleading |
Remember: Templates are starting points. Adapt to your project's needs.
This skill is applicable to execute the workflow or actions described in the overview.