技术文档类型

来自TC WIKI
跳到导航 跳到搜索

通用 (General)

  • 白皮书 (White Paper)
  • 发布说明 (Release Notes)
  • 商业视频 (Business Video)
  • 博客和论坛 (Blog, Weibo, Wechat, Forum, BBS)

市场 (Marketing)

  • 数据表 (Data Sheet)
  • 案例说明 (Application Note,Reference Description)
  • 宣传册 (Brochure)
  • 广告 (Leaflet,Poster,Rollup)

终端用户 (End-User)

  • 用户手册 (User's Guide, Manual, Tutorial, Getting-Started, Operation Instructions)
  • 在线或嵌入式帮助 (Online Help, Embedded Help)
  • 在线培训 (Online Training)
  • 视频演示 (Video Demo)
  • 术语表 (Glossary)
  • 用例 (Use Case)

系统管理员 (System Administrator)

  • 配置手册 (Configuration Guide)
  • 部署手册 (Deployment Guide)
  • 安装手册 (Installation Guide, Readme)
  • 环境(软硬件)要求 (Environment Guide, Software/Hardware Requirements)

开发人员 (Developer)

  • API文档 (API Reference Library, API Developer's Guide)
  • SDK文档 (Software Development Kit Documentation)
  • 概要设计说明书(High Level Design)
  • 详细设计说明书(Detailed Specification)

技术支持人员 (Support)

  • 知识库和常见问题 (Knowledge Base Article, FAQs)
  • 保养手册 (Maintenance)
  • 故障排除 (Troubleshooting Guide)
  • 安全手册 (Safety Manual)
  • 调试指南 (Commissioning Instructions)
  • 测试用例 (Test Case)
  • 测试报告 (Test Report)
  • 工艺流程 (Procedure)

其他 (Miscellaneous)

  • 内部开发测试文档 (Internal Development and Test Documents)
  • 内部流程和规范 (Internal Processes and Standards)
  • 商业价值 (Business Value, ROI Claims)
  • 版权 (Copyright)
  • 服务等级协议 (Service-Level Agreement)
  • 方法论文档 (Methodology Document)
  • 培训材料 (Training Material)
  • 分析报告 (Analysis Report)