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
Pod::Simple::Wiki::Usemod(3pm)				User Contributed Perl Documentation			    Pod::Simple::Wiki::Usemod(3pm)

NAME
Pod::Simple::Wiki::Usemod - A class for creating Pod to Usemod wiki filters. SYNOPSIS
This module isn't used directly. Instead it is called via "Pod::Simple::Wiki": #!/usr/bin/perl -w use strict; use Pod::Simple::Wiki; my $parser = Pod::Simple::Wiki->new('usemod'); ... Convert Pod to a Usemod wiki format using the installed "pod2wiki" utility: pod2wiki --style usemod file.pod > file.wiki DESCRIPTION
The "Pod::Simple::Wiki::Usemod" module is used for converting Pod text to Wiki text. Pod (Plain Old Documentation) is a simple markup language used for writing Perl documentation. For an introduction to Usemod see: http://www.usemod.com/cgi-bin/wiki.pl This module isn't generally invoked directly. Instead it is called via "Pod::Simple::Wiki". See the Pod::Simple::Wiki and pod2wiki documentation for more information. METHODS
Pod::Simple::Wiki::Usemod inherits all of the methods of "Pod::Simple" and "Pod::Simple::Wiki". See Pod::Simple and Pod::Simple::Wiki for more details. SEE ALSO
This module also installs a "pod2wiki" command line utility. See "pod2wiki --help" for details. ACKNOWLEDGEMENTS
Submit a bugfix or test and your name will go here. DISCLAIMER OF WARRANTY
Please refer to the DISCLAIMER OF WARRANTY in Pod::Simple::Wiki. AUTHORS
John McNamara jmcnamara@cpan.org COPYRIGHT
X MMIII-MMVIII, John McNamara. All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself. perl v5.10.1 2009-08-26 Pod::Simple::Wiki::Usemod(3pm)