技术文档的致命之罪

T. Rivera, A. Tate, S. Will
{"title":"技术文档的致命之罪","authors":"T. Rivera, A. Tate, S. Will","doi":"10.1109/SECON.2004.1287934","DOIUrl":null,"url":null,"abstract":"During the latter-half of 2003, the authors embarked on a project aimed at establishing objective answers to a seemingly ethereal but straightforward question: by what criteria can you tell you have produced a high-quality document? In the process of their research, the authors discovered there were consistent patterns of clear and obvious errors to be avoided when producing technical documentation; this paper is an effort to share their conclusions. While their particular area of interest is technical documentation within the realm of software engineering, their findings have broader applicability.","PeriodicalId":324953,"journal":{"name":"IEEE SoutheastCon, 2004. Proceedings.","volume":"7 1","pages":"0"},"PeriodicalIF":0.0000,"publicationDate":"2004-03-26","publicationTypes":"Journal Article","fieldsOfStudy":null,"isOpenAccess":false,"openAccessPdf":"","citationCount":"4","resultStr":"{\"title\":\"Deadly Sins of Technical Documentation\",\"authors\":\"T. Rivera, A. Tate, S. Will\",\"doi\":\"10.1109/SECON.2004.1287934\",\"DOIUrl\":null,\"url\":null,\"abstract\":\"During the latter-half of 2003, the authors embarked on a project aimed at establishing objective answers to a seemingly ethereal but straightforward question: by what criteria can you tell you have produced a high-quality document? In the process of their research, the authors discovered there were consistent patterns of clear and obvious errors to be avoided when producing technical documentation; this paper is an effort to share their conclusions. While their particular area of interest is technical documentation within the realm of software engineering, their findings have broader applicability.\",\"PeriodicalId\":324953,\"journal\":{\"name\":\"IEEE SoutheastCon, 2004. Proceedings.\",\"volume\":\"7 1\",\"pages\":\"0\"},\"PeriodicalIF\":0.0000,\"publicationDate\":\"2004-03-26\",\"publicationTypes\":\"Journal Article\",\"fieldsOfStudy\":null,\"isOpenAccess\":false,\"openAccessPdf\":\"\",\"citationCount\":\"4\",\"resultStr\":null,\"platform\":\"Semanticscholar\",\"paperid\":null,\"PeriodicalName\":\"IEEE SoutheastCon, 2004. Proceedings.\",\"FirstCategoryId\":\"1085\",\"ListUrlMain\":\"https://doi.org/10.1109/SECON.2004.1287934\",\"RegionNum\":0,\"RegionCategory\":null,\"ArticlePicture\":[],\"TitleCN\":null,\"AbstractTextCN\":null,\"PMCID\":null,\"EPubDate\":\"\",\"PubModel\":\"\",\"JCR\":\"\",\"JCRName\":\"\",\"Score\":null,\"Total\":0}","platform":"Semanticscholar","paperid":null,"PeriodicalName":"IEEE SoutheastCon, 2004. Proceedings.","FirstCategoryId":"1085","ListUrlMain":"https://doi.org/10.1109/SECON.2004.1287934","RegionNum":0,"RegionCategory":null,"ArticlePicture":[],"TitleCN":null,"AbstractTextCN":null,"PMCID":null,"EPubDate":"","PubModel":"","JCR":"","JCRName":"","Score":null,"Total":0}
引用次数: 4

摘要

在2003年下半年,作者开始了一个项目,旨在为一个看似虚无缥缈但直截了当的问题建立客观的答案:通过什么标准可以判断您已经生成了高质量的文档?在他们的研究过程中,作者发现,在制作技术文档时,有一些清晰而明显的错误需要避免;本文旨在分享他们的结论。虽然他们特别感兴趣的领域是软件工程领域内的技术文档,但他们的发现具有更广泛的适用性。
本文章由计算机程序翻译,如有差异,请以英文原文为准。
Deadly Sins of Technical Documentation
During the latter-half of 2003, the authors embarked on a project aimed at establishing objective answers to a seemingly ethereal but straightforward question: by what criteria can you tell you have produced a high-quality document? In the process of their research, the authors discovered there were consistent patterns of clear and obvious errors to be avoided when producing technical documentation; this paper is an effort to share their conclusions. While their particular area of interest is technical documentation within the realm of software engineering, their findings have broader applicability.
求助全文
通过发布文献求助,成功后即可免费获取论文全文。 去求助
来源期刊
自引率
0.00%
发文量
0
×
引用
GB/T 7714-2015
复制
MLA
复制
APA
复制
导出至
BibTeX EndNote RefMan NoteFirst NoteExpress
×
提示
您的信息不完整,为了账户安全,请先补充。
现在去补充
×
提示
您因"违规操作"
具体请查看互助需知
我知道了
×
提示
确定
请完成安全验证×
copy
已复制链接
快去分享给好友吧!
我知道了
右上角分享
点击右上角分享
0
联系我们:info@booksci.cn Book学术提供免费学术资源搜索服务,方便国内外学者检索中英文文献。致力于提供最便捷和优质的服务体验。 Copyright © 2023 布克学术 All rights reserved.
京ICP备2023020795号-1
ghs 京公网安备 11010802042870号
Book学术文献互助
Book学术文献互助群
群 号:481959085
Book学术官方微信