Documentation Templates workflow skill. Use this skill when the user needs Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation and the operator should preserve the upstream workflow, copied support files, and provenance before merging or handing off.
Documentation Templates workflow skill. Use this skill when the user needs Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation and the operator should preserve the upstream workflow, copied support files, and provenance before merging or handing off.
This public intake copy packages plugins/antigravity-awesome-skills/skills/documentation-templates from https://github.com/sickn33/antigravity-awesome-skills into the native Omni Skills editorial shape without hiding its origin.
Use it when the operator needs the upstream workflow, support files, and repository context to stay intact while the public validator and private enhancer continue their normal downstream flow.
This intake keeps the copied upstream files intact and uses the external_source block in metadata.json plus ORIGIN.md as the provenance anchor for review.
Documentation Templates > Templates and structure guidelines for common documentation types. ---
Imported source sections that did not map cleanly to the public headings are still preserved below or in the support files. Notable imported sections: 1. README Structure, Features, Configuration, Documentation, License, 2. API Documentation Structure.
When to Use This Skill
Use this section as the trigger filter. It should make the activation boundary explicit before the operator loads files, runs commands, or opens a pull request.
This skill is applicable to execute the workflow or actions described in the overview.
Use when the request clearly matches the imported source intent: Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.
Use when the operator should preserve upstream workflow detail instead of rewriting the process from scratch.
Use when provenance needs to stay visible in the answer, PR, or review packet.
Use when copied upstream references, examples, or scripts materially improve the answer.
Use when the workflow should remain reviewable in the public intake repo before the private enhancer takes over.
Operating Table
Situation
Start here
Why it matters
First-time use
metadata.json
Confirms repository, branch, commit, and imported path through the external_source block before touching the copied workflow
Provenance review
ORIGIN.md
Gives reviewers a plain-language audit trail for the imported source
Workflow execution
SKILL.md
Starts with the smallest copied file that materially changes execution
Supporting context
SKILL.md
Adds the next most relevant copied source file without loading the entire package
Handoff decision
## Related Skills
Helps the operator switch to a stronger native skill when the task drifts
Workflow
This workflow is intentionally editorial and operational at the same time. It keeps the imported source useful to the operator while still satisfying the public intake standards that feed the downstream enhancer flow.
Confirm the user goal, the scope of the imported workflow, and whether this skill is still the right router for the task.
Read the overview and provenance files before loading any copied upstream support files.
Load only the references, examples, prompts, or scripts that materially change the outcome for the current request.
Execute the upstream workflow while keeping provenance and source boundaries explicit in the working notes.
Validate the result against the upstream expectations and the evidence you can point to in the copied files.
Escalate or hand off to a related skill when the work moves out of this imported workflow's center of gravity.
Before merge or closure, record what was used, what changed, and what the reviewer still needs to verify.
Imported Workflow Notes
Imported: 1. README Structure
Essential Sections (Priority Order)
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
README Template
# Project Name
Brief one-line description.
## Examples### Example 1: Ask for the upstream workflow directly```text
Use @documentation-templates-v2 to handle <task>. Start from the copied upstream workflow, load only the files that change the outcome, and keep provenance visible in the answer.
Explanation: This is the safest starting point when the operator needs the imported workflow, but not the entire repository.
Example 2: Ask for a provenance-grounded review
Review @documentation-templates-v2 against metadata.json and ORIGIN.md, then explain which copied upstream files you would load first and why.
Explanation: Use this before review or troubleshooting when you need a precise, auditable explanation of origin and file selection.
Example 3: Narrow the copied support files before execution
Use @documentation-templates-v2 for <task>. Load only the copied references, examples, or scripts that change the outcome, and name the files explicitly before proceeding.
Explanation: This keeps the skill aligned with progressive disclosure instead of loading the whole copied package by default.
Example 4: Build a reviewer packet
Review @documentation-templates-v2 using the copied upstream files plus provenance, then summarize any gaps before merge.
Explanation: This is useful when the PR is waiting for human review and you want a repeatable audit packet.
Imported Usage Notes
Imported: Quick Start
[Minimum steps to run]
Best Practices
Treat the generated public skill as a reviewable packaging layer around the upstream repository. The goal is to keep provenance explicit and load only the copied source material that materially improves execution.
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
Imported Operating Notes
Imported: 3. Code Comment Guidelines
JSDoc/TSDoc Template
/**
* Brief description of what the function does.
*
* @paramparamName - Description of parameter
* @returns Description of return value
* @throwsErrorType - When this error occurs
*
* @example
* const result = functionName(input);
*/
When to Comment
✅ Comment
❌ Don't Comment
Why (business logic)
What (obvious)
Complex algorithms
Every line
Non-obvious behavior
Self-explanatory code
API contracts
Implementation details
Imported: 7. Structure Principles
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.
Troubleshooting
Problem: The operator skipped the imported context and answered too generically
Symptoms: The result ignores the upstream workflow in plugins/antigravity-awesome-skills/skills/documentation-templates, fails to mention provenance, or does not use any copied source files at all.
Solution: Re-open metadata.json, ORIGIN.md, and the most relevant copied upstream files. Check the external_source block first, then restate the provenance before continuing.
Problem: The imported workflow feels incomplete during review
Symptoms: Reviewers can see the generated SKILL.md, but they cannot quickly tell which references, examples, or scripts matter for the current task.
Solution: Point at the exact copied references, examples, scripts, or assets that justify the path you took. If the gap is still real, record it in the PR instead of hiding it.
Problem: The task drifted into a different specialization
Symptoms: The imported skill starts in the right place, but the work turns into debugging, architecture, design, security, or release orchestration that a native skill handles better.
Solution: Use the related skills section to hand off deliberately. Keep the imported provenance visible so the next skill inherits the right context instead of starting blind.
Related Skills
@00-andruia-consultant - Use when the work is better handled by that native specialization after this imported skill establishes context.
@00-andruia-consultant-v2 - Use when the work is better handled by that native specialization after this imported skill establishes context.
@10-andruia-skill-smith - Use when the work is better handled by that native specialization after this imported skill establishes context.
@10-andruia-skill-smith-v2 - Use when the work is better handled by that native specialization after this imported skill establishes context.
Additional Resources
Use this support matrix and the linked files below as the operator packet for this imported skill. They should reflect real copied source material, not generic scaffolding.
Resource family
What it gives the reviewer
Example path
references
copied reference notes, guides, or background material from upstream
references/n/a
examples
worked examples or reusable prompts copied from upstream
examples/n/a
scripts
upstream helper scripts that change execution or validation
scripts/n/a
agents
routing or delegation notes that are genuinely part of the imported package
agents/n/a
assets
supporting assets or schemas copied from the source package
assets/n/a
Imported Reference Notes
Imported: Features
Feature 1
Feature 2
Imported: Configuration
Variable
Description
Default
PORT
Server port
3000
Imported: Documentation
API Reference
Architecture
Imported: License
MIT
---
#### Imported: 2. API Documentation Structure
### Per-Endpoint Template
```markdown
#### Imported: 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]
Imported: 4. Changelog Template (Keep a Changelog)
# ADR-001: [Title]#### Imported: Status
Accepted / Deprecated / Superseded
#### Imported: Context
Why are we making this decision?
#### Imported: Decision
What did we decide?
#### Imported: Consequences
What are the trade-offs?
