tech-documentation-dd3358 — independently scanned and version-tracked by SaferSkills.
SaferSkills independently audited tech-documentation-dd3358 (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.
技术文档编写技能库,提供全面的技术文档写作方法论和模板。
触发场景:当用户提出以下请求时,使用本 skill:
这是一个专注于技术文档编写的综合性技能模块,涵盖各类技术文档的编写规范、模板和最佳实践,帮助团队产出高质量、易理解、易维护的技术文档。
API文档模板(OpenAPI格式、接口列表、错误码、变更日志):参见 references/api-doc-template.md 架构设计文档模板(概述、需求、架构设计、技术栈、数据架构、部署):参见 references/architecture-template.md 部署文档模板(环境、前置条件、部署步骤、回滚、监控):参见 references/deployment-template.md
为新项目创建完整的文档体系:
- README.md
- API文档
- 架构设计文档
- 部署文档
- 贡献指南编写API设计文档,包括:
- 接口定义
- 数据模型
- 错误处理
- 安全认证准备系统交付文档包:
- 系统架构文档
- 部署运维手册
- 用户使用手册
- 故障处理手册技术方案总结:
- 问题分析
- 解决方案
- 技术决策
- 经验教训{
"agent": "tech-writer",
"skills": [
"tech-documentation",
"system-architecture",
"api-design"
]
}@tech-documentation 请为这个API创建完整的文档任务:「为 POST /login 接口写一份 API 文档」
第一步——与需求方确认范围。 读者:第三方接入方; 结构遵循 references/api-doc-template.md; 响应信封采用下方示例中的 {code, message, data, request_id, timestamp} 字段约定(如项目使用其他信封格式,需先明确写出定义)。
第二步——撰写文档。
验证用户身份并返回访问令牌。
请求体
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| username | string | 是 | 账号名或邮箱 |
| password | string | 是 | 账号密码(需 TLS) |
{
"username": "john_doe",
"password": "s3cret!"
}响应 200
{
"code": 0,
"message": "Success",
"data": { "token": "eyJhbGciOi...", "expires_in": 3600 },
"request_id": "req_abc123",
"timestamp": "2026-10-08T10:30:00Z"
}响应 401——凭证无效
{
"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!"}'第三步——自查:对照下方的文档质量检查清单逐项核对 (接口地址、参数表、成功与错误响应、可运行示例均已覆盖)。
版本: 1.0.0 最后更新: 2024-12 维护者: MindForge Team
~30 seconds. Free. No account. Every finding cites a rule and a line of evidence.