[go: up one dir, main page]
More Web Proxy on the site http://driver.im/ skip to main content
10.1145/501516.501543acmconferencesArticle/Chapter ViewAbstractPublication PagesdocConference Proceedingsconference-collections
Article

Open-source documentation: in search of user-driven, just-in-time writing

Published: 21 October 2001 Publication History

Abstract

Iterative development models allow developers to respond quickly to changing user requirements, but place increasing demands on writers who must handle increasing amounts of change with ever-decreasing resources. In the software development world, one solution to this problem is open-source development: allowing the users to set requirements and priorities by actually contributing to the development of the software. This results in just-in-time software improvements that are explicitly user-driven, since they are actually developed by users.In this article we will discuss how the open source model can be extended to the development of documentation. In many open-source projects, the role of writer has remained unchanged: documentation development remains a specialized activity, owned by a single writer or group of writers, who work as best they can with key developers and frequently out-of-date specification documents. However, a potentially more rewarding approach is to open the development of the documentation to the same sort of community involvement that gives rise to the software: using forums and mailing lists as the tools for developing documentation, driven by debate and dialogue among the actual users and developers.Just as open-source development blurs the line between user and developer, open-source documentation will blur the line between reader and writer. Someone who is a novice reader in one area may be an expert author in another. Two key activities emerge for the technical writer in such a model: as gatekeeper and moderator for FAQs and formal documentation, and as literate expert user of the system they are documenting.

References

[1]
Apache (open-source web server) http://www.apache.org
[2]
Carroll J. M. (Ed.) (1998) Minimalism Beyond the Nurnberg Funnel MIT Press 1998, Cambridge, Massachusets.
[3]
Debian (open-source Linux) http:// www.debian.org
[4]
DiBona C., Ockman S., and Stone M. (Eds.) (1999) Open Sources: Voices from the Open Source Revolution O'Reilly
[5]
Feller J., and Fitzgerald B. (2000) A Framework Analysis of the Open Source Software Development Paradigm In Proceedings of the 21 st International Conference on Information Systems 2000, Brisbane pp. 10-13
[6]
Feller J., Fitzgerald B., and van der Hoek, A. (2001) (W18) 1:st Workshop on Open Source Software Engineering, position paper for the workshop In Proceedings of the 23rd International Conference on Software Engineering, 2001 pp. 780 -781
[7]
GNU Emacs (open-source extensible editor) http://www.gnu.org/software/emacs/
[8]
GNU Free Documentation License http://www.gnu.org/copyleft/fdl.html
[9]
GNU Software (original free software initiative, origin of open-source) http://www.gnu.org
[10]
Jones P. (2001) Open(sourcing) the Doors: for Contributor-Run Digital Libraries Communications of the ACM vol. 44. no. 5 pp. 45-46
[11]
Linux Documentation Project copying license, viewed August 2001. http://www.linuxdoc.org/LDP-COPYRIGHT. html
[12]
Linux.org (central source of Linux information) http://www.linux.org
[13]
Mozilla (open-source web browser, development project for Netscape 6, based on the original Netscape source code) http://www.mozilla.org
[14]
MySQL annotated manual (online annotated manual) http://www.mysql.com/doc/
[15]
Netcraft Web Server Surveys, viewed June 2001 http://www.netcraft.com/survey/
[16]
Nupedia (open-source encyclopedia) http://www.nupedia.com/
[17]
Open Content License http://www.opencontent.org
[18]
Open Source Initiative http://www.opensource.org
[19]
Open Source Initiative, definition of open-source http://www.opensource.org/docs/definition.html
[20]
Perence B. (1999) The Open Source Definition in Open Sources: Voices from the Open Source Revolution, Eds. DiBona C.,
[21]
Perkins (1999) Culture Clash and the Road to World Domination IEEE Software January/February 1999 pp. 80- 84
[22]
Perl (open source programming language) http://www.perl.org
[23]
PHP annotated manual (online annotated manual) http://www.php.net/manual/en/
[24]
Priestley, M. (2001) DITA XML: A Reuse by Reference Architecture for Technical Documentation Conference Proceedings, ACM SIGDOC 2001
[25]
Priestley, M., and Utt, M. H. (2000) A unified process for software and documentation development Conference Proceedings, IEEE/ACM IPCC/SIGDOC 2000
[26]
Python (open source programming language) http://www.python.org
[27]
Raymond E. S. (1999a) The Cathedral and the Bazaar, O'Reilly
[28]
Raymond E. S. (1999b) A Brief History of Hackerdom in Open Sources: Voices from the Open Source Revolution, Eds. DiBona C., Ockman S., and Stone M., O'Reilly
[29]
Raymond E. S. (1999c) Linux and Open-Source Success (interview) IEEE Software January/February 1999 pp. 85-89
[30]
Sanders J. (1998) Linux, Open Source, and Software's Future IEEE Software September/October 1998 pp 88-91
[31]
Slashdot (open software e-zine) viewed August 2001 http://slashdot.org/about.shtml
[32]
SourceForge (web site for multiple open source projects) http://sourceforge.net/
[33]
Stallman R (1999) The GNU Operating System and the Free Software Movement in Open Sources: Voices from the Open Source Revolution, Eds. DiBona C., Ockman S., and Stone M., O'Reilly
[34]
Stanford Copyright and Fair Use web site http://fairuse.stanford.edu
[35]
Squeek manual (online editable manual) http://squeak.cs.uiuc.edu/documentation/index.html
[36]
Utt, M.H., and Mathews, R. (1999) Developing a User Information Architecture for Rational's ClearCase Product Family Documentation Set. Conference Proceedings, ACM SIGDOC 1999, pages 86-92.
[37]
Vixie P. (1999) Software Engineering in Open Sources: Voices from the Open Source Revolution, Eds. DiBona C., Ockman S., and Stone M., O'Reilly
[38]
Wikipedia (open-source encyclopedia) http://www.wikipedia.com
[39]
Willson (1999) Is the Open-source Community setting a Bad Example? IEEE Software January/February 1999 pp. 23-25

Cited By

View all
  • (2024)Towards Leveraging LLMs for Reducing Open Source Onboarding Information OverloadProceedings of the 39th IEEE/ACM International Conference on Automated Software Engineering10.1145/3691620.3695286(2210-2214)Online publication date: 27-Oct-2024
  • (2017)Forum design and the changing landscape of crowd-sourced help informationCommunication Design Quarterly10.1145/3068698.30687004:2(12-22)Online publication date: 22-Mar-2017
  • (2017)End-user support for primary care electronic medical records: a qualitative case study of users’ needs, expectations, and realitiesHealth Systems10.1057/hs.2013.62:3(198-212)Online publication date: 19-Dec-2017
  • Show More Cited By

Recommendations

Comments

Please enable JavaScript to view thecomments powered by Disqus.

Information & Contributors

Information

Published In

cover image ACM Conferences
SIGDOC '01: Proceedings of the 19th annual international conference on Computer documentation
October 2001
272 pages
ISBN:1581132956
DOI:10.1145/501516
Permission to make digital or hard copies of all or part of this work for personal or classroom use is granted without fee provided that copies are not made or distributed for profit or commercial advantage and that copies bear this notice and the full citation on the first page. Copyrights for components of this work owned by others than ACM must be honored. Abstracting with credit is permitted. To copy otherwise, or republish, to post on servers or to redistribute to lists, requires prior specific permission and/or a fee. Request permissions from [email protected]

Sponsors

Publisher

Association for Computing Machinery

New York, NY, United States

Publication History

Published: 21 October 2001

Permissions

Request permissions for this article.

Check for updates

Qualifiers

  • Article

Conference

SIGDOC01
Sponsor:
SIGDOC01: 19th International Conference on Systems Documentation
October 21 - 24, 2001
New Mexico, Sante Fe, USA

Acceptance Rates

Overall Acceptance Rate 355 of 582 submissions, 61%

Contributors

Other Metrics

Bibliometrics & Citations

Bibliometrics

Article Metrics

  • Downloads (Last 12 months)18
  • Downloads (Last 6 weeks)0
Reflects downloads up to 28 Jan 2025

Other Metrics

Citations

Cited By

View all
  • (2024)Towards Leveraging LLMs for Reducing Open Source Onboarding Information OverloadProceedings of the 39th IEEE/ACM International Conference on Automated Software Engineering10.1145/3691620.3695286(2210-2214)Online publication date: 27-Oct-2024
  • (2017)Forum design and the changing landscape of crowd-sourced help informationCommunication Design Quarterly10.1145/3068698.30687004:2(12-22)Online publication date: 22-Mar-2017
  • (2017)End-user support for primary care electronic medical records: a qualitative case study of users’ needs, expectations, and realitiesHealth Systems10.1057/hs.2013.62:3(198-212)Online publication date: 19-Dec-2017
  • (2016)Does the Speed of Problems Comment Affect GitHub Open Source Software Development Process?Advanced Multimedia and Ubiquitous Engineering10.1007/978-981-10-1536-6_99(769-775)Online publication date: 30-Aug-2016
  • (2015)Building foundations for the crowdProceedings of the 33rd Annual International Conference on the Design of Communication10.1145/2775441.2775461(1-10)Online publication date: 16-Jul-2015
  • (2015)Cost, benefits and quality of software development documentationJournal of Systems and Software10.1016/j.jss.2014.09.04299:C(175-198)Online publication date: 1-Jan-2015
  • (2013)Open Source Software Development Process ModelJournal of Global Information Management10.4018/jgim.201310010621:4(103-120)Online publication date: 1-Oct-2013
  • (2012)Documentation practices in scientific software developmentProceedings of the 5th International Workshop on Co-operative and Human Aspects of Software Engineering10.5555/2663638.2663662(113-119)Online publication date: 2-Jun-2012
  • (2011)Carrying That Ten Thousand Dollar Lab in a BacksackOpen Source Mobile Learning10.4018/978-1-60960-613-8.ch007(94-109)Online publication date: 2011
  • (2010)Expect the unexpectedProceedings of the 9th ACM SIGPLAN-SIGSOFT workshop on Program analysis for software tools and engineering10.1145/1806672.1806687(73-80)Online publication date: 5-Jun-2010
  • Show More Cited By

View Options

Login options

View options

PDF

View or Download as a PDF file.

PDF

eReader

View online with eReader.

eReader

Figures

Tables

Media

Share

Share

Share this Publication link

Share on social media