Using a wiki for FOSS application documentation


 
Thread Tools Search this Thread
Special Forums News, Links, Events and Announcements UNIX and Linux RSS News Using a wiki for FOSS application documentation
# 1  
Old 05-09-2008
Using a wiki for FOSS application documentation

Fri, 09 May 2008 08:00:00 GMT
For a lot of programmers, writing an application is fun, but writing its manual is not. Adding new features, refining the product, and responding to users' input are all more rewarding than writing instructions on how to use the software. However, good documentation is necessary to have happy, informed users who can contribute meaningfully to future development. A few months ago, Gilbert Ashley, the author of src2pkg (Slackware's "magic package maker") invited me and two other people to help him manage the user documentation for his program. The process we used to create the src2pkg wiki may be a useful example for other free and open source software (FOSS) application developers.


Source...
Login or Register to Ask a Question

Previous Thread | Next Thread

6 More Discussions You Might Find Interesting

1. What is on Your Mind?

Is M.Sc (FOSS) worth doing?

Recently while reading an linux magazine I understood that FOSS (Free or open source software) is gaining momentum.. And in my home town there is an reputed university which offers M.Sc online program on FOSS. The course covers: INTRODUCTION TO COMPUTING, PHILOSOPHY AND PRACTICE OF FOSS,... (4 Replies)
Discussion started by: Arun_Linux
4 Replies

2. UNIX for Dummies Questions & Answers

wiki

Please i am trying to create an intranet wiki in my work place but i have no idea what to do, please if you can guide me on how to go about it i will really appreciate it. thanks (1 Reply)
Discussion started by: bensen
1 Replies

3. Solaris

Wiki on Solaris

Hi, i want to install wiki on solaris, to make my own wikipedia inside my company. I'm using Solaris 10. Can someone help me with this, give me some directions, what do i have to install, some step by step guide. thanks in advance :) (4 Replies)
Discussion started by: n00b
4 Replies

4. AIX

Wiki on AIX

Hi I am wanting to download and install Wiki Software on an AIX server and have no idea which one or where to start ; preferably Open Source - anyone any ideas? Thanks (5 Replies)
Discussion started by: carole_76
5 Replies

5. UNIX for Dummies Questions & Answers

Wiki on AIX

Hi I am wanting to download and install Wiki Software on an AIX server and have no idea which one or where to start ; preferably Open Source - anyone any ideas? Thanks (1 Reply)
Discussion started by: carole_76
1 Replies

6. Web Development

wiki -- heard about them, tell me more

I have heard about companies setting up wiki sites to allow for user grops to workshare information via the web. When I said something about this to someone, was told it was a lot of work to setup. Anyone care to comment on what is truly needed? The materials needed, effort required, whether it... (4 Replies)
Discussion started by: joeyg
4 Replies
Login or Register to Ask a Question
NEWBIEDOC(1)						      General Commands Manual						      NEWBIEDOC(1)

NAME
newbiedoc - Debian documentation for newbies by newbies. SYNOPSIS
newbiedoc newbiedoc file DESCRIPTION
This manual page documents briefly the newbiedoc command. The program newbiedoc is a small script that starts your favorite browser and displays the index page of the NewbieDOC documentation package. Optionally, you can specify the name of a specific file to open in the browser. newbiedoc can also be run directly from the Debian menu in the X Window System: Debian -> Help -> NewbieDOC. NewbieDOC documentation is in the form of HTML files which form a snapshot of the documentation currently being developed by the Debian NewbieDOC project. Visit the wiki at http://newbiedoc.berlios.de for the most recent versions, or if you wish to contribute to the project. The wiki is very easy to use. All Debian users are encouraged to author, edit or add comments to the articles. Each NewbieDOC item is either explicitly licensed by its author, or licensed globally under the GNU Free Documentation License. SEE ALSO
The NewbieDOC wiki is at http://newbiedoc.berlios.de AUTHOR
The upstream source for newbiedoc was written by Chris Lale <chrislale@untrammelled.co.uk>. This manual page was written by Chris Lale <chrislale@untrammelled.co.uk>, for the Debian project (but may be used by others). 27th September 2009 NEWBIEDOC(1)