技術文檔：修订间差异

删除的内容添加的内容

行内

2021年2月23日 (二) 05:59的版本

技术文档是一種描述技术产品或正在开发或已投入使用的产品的功能和结构的文档 ^[1] ^[2] ^[3]。产品技术文档的讀者包括终端用户以及技术維護人员。有些技术公司會讓技术写作人员負責将產品开发阶段公司撰寫的技術文檔翻译成用戶更易读的文章。

一项技术附带的文档通常是用户完全了解该技术的唯一手段。无论如何，软件开发人员通常将技术文档视为“必要的邪恶”。因此，由于缺乏关注和准确性，该类型受到了一些行业专家的哀叹。 ^[4]编写和维护文档涉及许多技术和非技术技能，因此与编写和维护代码相比，这项工作通常不那么享受或得到回报。 ^[5] [[Category:技術通信]] [[Category:文件]]

^ What is "technical documentation"? at Transcom.de. Accessed February 25, 2013.
^ What is Technical Documentation? Archive.is的存檔，存档日期2013-04-18 at Tetras Translations. Accessed February 25, 2013.
^ Documenting the New System at IGCSE ICT. Accessed February 25, 2013.
^ The Documentation Scene by John Mobbs. Institute of Scientific and Technical Communicators, Monday, July 23, 2012.
^ Geiger, R. Stuart; Varoquaux, Nelle; Mazel-Cabasse, Charlotte; Holdgraf, Chris. The Types, Roles, and Practices of Documentation in Data Analytics Open Source Software Libraries. Computer Supported Cooperative Work (CSCW). 2018-05-29, 27 (3–6): 767–802. ISSN 0925-9724. arXiv:1805.12398 . doi:10.1007/s10606-018-9333-1 （英语）.

[1] What is "technical documentation"? at Transcom.de. Accessed February 25, 2013.

[2] What is Technical Documentation? Archive.is的存檔，存档日期2013-04-18 at Tetras Translations. Accessed February 25, 2013.

[3] Documenting the New System at IGCSE ICT. Accessed February 25, 2013.

[mob-4] The Documentation Scene by John Mobbs. Institute of Scientific and Technical Communicators, Monday, July 23, 2012.

[5] Geiger, R. Stuart; Varoquaux, Nelle; Mazel-Cabasse, Charlotte; Holdgraf, Chris. The Types, Roles, and Practices of Documentation in Data Analytics Open Source Software Libraries. Computer Supported Cooperative Work (CSCW). 2018-05-29, 27 (3–6): 767–802. ISSN 0925-9724. arXiv:1805.12398 . doi:10.1007/s10606-018-9333-1 （英语）.

[1]

[2]

[3]

[4]

[5]