القائمة
Documentation templates for software projects. Use when writing READMEs, PR descriptions, changelogs, API docs, or code comments. Provides copy-paste templates for common documentation needs.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
Zero-dependency scaffold for building autonomous agents: OpenAI-compatible LLM client, dynamic skill loading, Python code execution in an isolated workspace, and two-tier persistent memory. Use when you need to bootstrap a new agent or want a reusable agent template that works with any /v1 endpoint.
Generate ASCII art text banners. Use when you want to make output stand out, create headers, or add visual flair to terminal output.
Summarize a GitHub repository. Use when you need a quick overview of what a repo does, its structure, and key technologies. Returns a concise summary with purpose, tech stack, and structure.
| name | doc-templates |
| description | Documentation templates for software projects. Use when writing READMEs, PR descriptions, changelogs, API docs, or code comments. Provides copy-paste templates for common documentation needs. |
| license | Unlicense |
| metadata | {"author":"jbpayton","version":"0.1","parent":"github.com/comet-ml/opik (documentation skill)"} |
Ready-to-use templates for common documentation tasks.
# Project Name
Brief one-line description.
## Installation
\`\`\`bash
pip install project-name
# or
npm install project-name
\`\`\`
## Quick Start
\`\`\`python
from project import something
result = something.do_thing()
\`\`\`
## Features
- Feature one
- Feature two
- Feature three
## Documentation
See [docs/](docs/) for full documentation.
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md).
## License
[MIT](LICENSE)
## Summary
- What this PR does (bullet points)
- Why it's needed
## Changes
- `file.py` - Added X functionality
- `test_file.py` - Added tests for X
## Test Plan
- [ ] Unit tests pass
- [ ] Manual testing done
- [ ] Edge cases covered
## Screenshots (if UI change)
Before | After
-------|------
img | img
## Related Issues
- Resolves #123
- Related to #456
## [VERSION] - YYYY-MM-DD
### Added
- New feature X (#123)
- Support for Y
### Changed
- Improved performance of Z
- Updated dependency A to v2.0
### Fixed
- Bug where X didn't work (#456)
- Memory leak in Y
### Removed
- Deprecated function Z
### Security
- Fixed vulnerability in X (CVE-XXXX-XXXX)
### Breaking Changes
- Renamed `old_func` to `new_func`
- Minimum Python version now 3.10
## `function_name(param1, param2, **kwargs)`
Brief description of what the function does.
### Parameters
| Name | Type | Default | Description |
|------|------|---------|-------------|
| param1 | str | required | What param1 does |
| param2 | int | 10 | What param2 does |
| **kwargs | dict | {} | Additional options |
### Returns
`ReturnType` - Description of return value
### Raises
- `ValueError` - When param1 is invalid
- `ConnectionError` - When server unreachable
### Example
\`\`\`python
result = function_name("hello", param2=5)
print(result) # Output: ...
\`\`\`
### Notes
- Important behavior to know
- Edge cases handled
def function_name(param1: str, param2: int = 10) -> ReturnType:
"""Brief one-line summary.
Longer description if needed. Explain the why,
not just the what.
Args:
param1: What this parameter does.
param2: What this parameter does. Defaults to 10.
Returns:
Description of what's returned.
Raises:
ValueError: When param1 is invalid.
Example:
>>> result = function_name("hello")
>>> print(result)
...
"""
class ClassName:
"""Brief one-line summary.
Longer description explaining purpose and usage.
Attributes:
attr1: Description of attr1.
attr2: Description of attr2.
Example:
>>> obj = ClassName(value)
>>> obj.do_something()
"""
"""Module brief description.
This module provides X functionality for Y purpose.
Example usage:
from module import thing
thing.do_stuff()
Typical usage patterns and important notes.
"""
x = x + 1)