Receber por email
← Voltar para o catálogo

tech-documentation

技术文档编写技能,涵盖 API 文档、架构文档、部署指南和各种技术写作最佳实践。使用此技能创建技术文档、编写 API 文档、创建架构设计文档,或需要部署和运维手册模板时使用。

3estrelas
Atualizado há 7 meses

Ver no GitHub ↗ Licença: MIT

Como adicionar

/plugin marketplace add ProjAnvil/MindForge

O comando exato pode variar conforme o repositório. Confira o README no GitHub.

Para o autor da skill

Cole no README do seu repo

Mostra que sua skill está catalogada na Skillteca, gera backlink e tráfego rastreável.

[![Skillteca](https://www.skillteca.com.br/api/badge/tech-documentation-projanvil/svg)](https://www.skillteca.com.br/skills/tech-documentation-projanvil)

Skills relacionadas

Ver todas de Automação →

Alerta por categoria

Receba novas skills de Automação toda segunda

1 email curto, só com as skills novas de Automação. 4 minutos de leitura, sem spam, cancela com 1 clique.

Você confirma o email no primeiro envio. Sem spam. Cancela com 1 clique.

Ler descrição completa

技术文档编写技能

技术文档编写技能库,提供全面的技术文档写作方法论和模板。

概述

这是一个专注于技术文档编写的综合性技能模块,涵盖各类技术文档的编写规范、模板和最佳实践,帮助团队产出高质量、易理解、易维护的技术文档。

核心能力

1. API文档

  • OpenAPI/Swagger规范
  • RESTful API文档
  • GraphQL文档
  • gRPC接口文档
  • API变更日志
  • 认证授权说明

2. 架构文档

  • 架构设计文档 (Architecture Design Document)
  • 架构决策记录 (Architecture Decision Records, ADR)
  • 系统架构图 (C4模型、UML)
  • 技术选型报告
  • 架构演进路线图

3. 详细设计文档

  • 模块设计文档
  • 数据库设计文档
  • 接口设计文档
  • 算法设计说明
  • 时序图/流程图

4. 部署运维文档

  • **

[Description truncada. Veja o README completo no GitHub.]

Compartilhar X LinkedIn