# Technical Writer

**Repository Path**: shenlan94/Technical-Writer

## Basic Information

- **Project Name**: Technical Writer
- **Description**: 技术文档写作指南
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2023-03-02
- **Last Updated**: 2023-03-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Technical Writer

 Enjoy the Fun of Technical Comminication
![Enjoy the Fun of Technical Comminication](imags/enjoy.png)

## 介绍
技术文档写作指南

## 软件架构
本项目旨在普及技术文档写作的点线面体框架，为个人技术提升，企业技术沉淀，产品功能介绍赋能，
如果您也很感兴趣一起推动这个项目的落地，造福中国软件技术文档撰写行业的话，那就参与进来八！！！

## 目录

- [Technical Writer](#Technical Writer)
    - [基础](#基础)
    - [技术写作主要做什么呢？](#技术写作主要做什么呢)
    - [怎样让人们简单的理解一个复杂的产品？](#怎样让人们简单的理解一个复杂的产品？)
    - [技术写作都有什么产品输出？](#技术写作都有什么产品输出？)
    - [其他](#其他)
- [技术写作都在哪里工作？](#技术写作都在哪里工作？)

- [技术写作需要什么样的能力？](#技术写作需要什么样的能力？)
    - [个人性格](#个人性格)
    - [对细节的敏感度](#对细节的敏感度)
    - [英语能力](#英语能力)
    - [优秀的写作能力](#优秀的写作能力)
    - [优秀的沟通能力](#优秀的沟通能力)
    - [团队协作能力](#团队协作能力)
    - [拥抱技术](#拥抱技术)
    - [快速学习能力](#快速学习能力)
    - [坚持成长](#坚持成长)
    - [图片创作以及编辑处理能力](#图片创作以及编辑处理能力)
    - [解决问题的能力以及耐心](#解决问题的能力以及耐心)

    
- [一个完整的技术文档写作流程](#一个完整的技术文档写作流程) 
      ![技术文档写作流程](imags/技术文档写作流程.png)
    - [Preparation 准备阶段](#Preparation准备阶段)  
    - [Research 调研阶段](#Research调研阶段)  
    - [Organization 文档架构](#Organization文档架构)
    - [Writing 文档写作](#Writing文档写作)
    - [Review & Revision审阅修改](#[Review&Revision审阅修改)
    - [Delivery 文档交付](#Delivery文档交付)
    
- **[技术写作的价值有哪些？](#技术写作的价值有哪些？)**
    - [复杂产品简单理解](#复杂产品简单理解)
    - [帮助工程师剖析问题去构建复杂产品](#帮助工程师剖析问题去构建复杂产品)

- [有哪些技术写作从业者必知必看的书籍？](#有哪些技术写作从业者必知必看的书籍？)
  > You must know what the rule is before you can break it.
    - [Developing Quality Technical Information](#dq) 
    - [DITA Best Practices](#da)
    - [The IBM Style Guide](#IBM)
    - [The Chicago Manual of Style](#ChIcag)
    - [Microsoft Manual of Style for Technical Publications](#Micro)
    - [Information Development](#InformationDevelopment)
    - [Technical Translation](#Technical)
    - [Style: Lessons in Clarity and Grace](#styl)
    - [Technical Communication](#TechnicalCommunication)
    - [Handbook of Technical Writing](#HTW)

     

- [Technical Writer 如何参与开源项目的文档，以不断提升专业技能?](提升专业技能)
    - [下载、安装并登录 GitHub Desktop](#GitHubDesktop)
    - [Fork 你想参与的项目仓库 (repository)](#Fork你想参与的项目仓库)
    - [将已 Fork 的远程仓库 Clone 至本地](#将已Fork的远程仓库Clone至本地)
    - [确保本地仓库与上游仓库内容一致](#确保本地仓库与上游仓库内容一致)
    - [新建一个 Branch。](#新建一个Branch)
    - [使用 Markdown 编辑器修改文档](#使用Markdown编辑器修改文档)
    - [将修改 Commit 到新建的 Branch](#将修改Commit到新建的Branch)
    - [将新建的 Branch 推至远程仓库](#将新建的Branch推至远程仓库)
    - [创建一个 Pull Request](#创建一个PullRequest)
    
    
- [技术写作经常都写什么？](#技术写作经常都写什么？)
    - [计算机软硬件产品](#计算机软硬件产品)
    - [软件开发的技术规范](#软件开发的技术规范)


## 参与贡献

1.  Fork 本仓库
2.  新建 Feat_Technical Writer 分支
3.  提交代码
4.  新建 Pull Request