Using the wiki to deliver paperless software documentation

K. Rettich
{"title":"Using the wiki to deliver paperless software documentation","authors":"K. Rettich","doi":"10.1109/IPCC.2011.6087219","DOIUrl":null,"url":null,"abstract":"A study was conducted to evaluate the delivery of software documentation as a dynamic paperless wiki to the customers of a software development company. The advantages and disadvantages of using a wiki to write and deliver software documentation were researched. Training modules were developed to teach the company employees effective techniques for using the company wiki to collaboratively write software user documentation. Evidence was also provided in a white paper that could be delivered to the customers to show that receiving their documentation as a wiki would be better for them than receiving traditional static hard-or soft-copy documentation. The goal of the project was to enable the employees to provide the customers with superior software documentation in the form of a wiki, which can be continuously updated and kept current as the software product evolves and eliminates the need for printing and maintaining a hard-copy library of the user documentation.","PeriodicalId":404833,"journal":{"name":"2011 IEEE International Professional Communication Conference","volume":"26 9-10 1","pages":"0"},"PeriodicalIF":0.0000,"publicationDate":"2011-11-28","publicationTypes":"Journal Article","fieldsOfStudy":null,"isOpenAccess":false,"openAccessPdf":"","citationCount":"6","resultStr":null,"platform":"Semanticscholar","paperid":null,"PeriodicalName":"2011 IEEE International Professional Communication Conference","FirstCategoryId":"1085","ListUrlMain":"https://doi.org/10.1109/IPCC.2011.6087219","RegionNum":0,"RegionCategory":null,"ArticlePicture":[],"TitleCN":null,"AbstractTextCN":null,"PMCID":null,"EPubDate":"","PubModel":"","JCR":"","JCRName":"","Score":null,"Total":0}
引用次数: 6

Abstract

A study was conducted to evaluate the delivery of software documentation as a dynamic paperless wiki to the customers of a software development company. The advantages and disadvantages of using a wiki to write and deliver software documentation were researched. Training modules were developed to teach the company employees effective techniques for using the company wiki to collaboratively write software user documentation. Evidence was also provided in a white paper that could be delivered to the customers to show that receiving their documentation as a wiki would be better for them than receiving traditional static hard-or soft-copy documentation. The goal of the project was to enable the employees to provide the customers with superior software documentation in the form of a wiki, which can be continuously updated and kept current as the software product evolves and eliminates the need for printing and maintaining a hard-copy library of the user documentation.
使用wiki交付无纸化软件文档
进行了一项研究,以评估软件文档作为动态无纸化wiki交付给软件开发公司的客户。研究了使用wiki编写和交付软件文档的优点和缺点。开发了培训模块,以教授公司员工使用公司wiki协作编写软件用户文档的有效技术。白皮书中还提供了证据,该白皮书可以交付给客户,以表明以wiki形式接收他们的文档比接收传统的静态硬拷贝或软拷贝文档更好。该项目的目标是使员工能够以wiki的形式向客户提供优质的软件文档,该文档可以随着软件产品的发展而不断更新和保持最新状态,并且消除了打印和维护用户文档的硬拷贝库的需要。
本文章由计算机程序翻译,如有差异,请以英文原文为准。
求助全文
约1分钟内获得全文 求助全文
来源期刊
自引率
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学术官方微信