tech-documentation-880489 — independently scanned and version-tracked by SaferSkills.
SaferSkills independently audited tech-documentation-880489 (Agent Skill) and scored it 100/100 (green). The audit ran 55 deterministic rules across Security, Supply Chain, Maintenance, Transparency, and Community; it found 0 high-severity and 0 lower-severity findings. The full rule-by-rule trace and per-finding evidence are below. Free, methodology-open.
Findings & checks · 0 flagged
Every scanned point with the score it earned and what moved between them.
First recorded scan — no prior version to compare against.
The primary manifest — the file an agent reads to learn what this artifact does.
Technical documentation writing expertise, providing comprehensive methodology and templates for producing high-quality technical documentation.
Trigger scenarios — use this skill when the user asks to:
This is a comprehensive skill module focused on technical documentation writing, covering standards, templates, and best practices for various types of technical documentation to help teams produce high-quality, easy-to-understand, and maintainable documentation.
API Documentation Template (OpenAPI format, endpoints, error codes, changelog): see references/api-doc-template.md
Architecture Design Document Template (overview, requirements, architecture, tech stack, data, deployment): see references/architecture-template.md
Deployment Documentation Template (environment, prerequisites, deployment steps, rollback, monitoring): see references/deployment-template.md
Create complete documentation system for new project:
- README.md
- API documentation
- Architecture design document
- Deployment documentation
- Contributing guidelinesWrite API design documentation, including:
- Interface definitions
- Data models
- Error handling
- Security authenticationPrepare system delivery documentation package:
- System architecture documentation
- Deployment and operations manual
- User manual
- Incident response manualTechnical solution summary:
- Problem analysis
- Solutions
- Technical decisions
- Lessons learned{
"agent": "tech-writer",
"skills": [
"tech-documentation",
"system-architecture",
"api-design"
]
}@tech-documentation Please create complete documentation for this APITask: "Write API documentation for a POST /login endpoint."
Step 1 — Scope with the requester. Audience: third-party integrators. Structure follows references/api-doc-template.md; responses use the {code, message, data, request_id, timestamp} envelope shown below (define it explicitly if your project uses a different one).
Step 2 — Write the document.
Authenticates a user and returns an access token.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
| username | string | yes | Account name or email |
| password | string | yes | Account password (TLS required) |
{
"username": "john_doe",
"password": "s3cret!"
}Response 200
{
"code": 0,
"message": "Success",
"data": { "token": "eyJhbGciOi...", "expires_in": 3600 },
"request_id": "req_abc123",
"timestamp": "2026-10-08T10:30:00Z"
}Response 401 — invalid credentials
{
"code": 40101,
"message": "Invalid username or password",
"request_id": "req_def456",
"timestamp": "2026-10-08T10:30:01Z"
}cURL
curl -X POST https://api.example.com/api/v1/login \
-H "Content-Type: application/json" \
-d '{"username": "john_doe", "password": "s3cret!"}'Step 3 — Self-check against the Documentation Quality Checklist below (endpoint, params, success + error responses, runnable example, all present).
Version: 1.0.0 Last Updated: December 2024 Maintainer: MindForge Team
~30 seconds. Free. No account. Every finding cites a rule and a line of evidence.