{"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}
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.