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
Mojolicious::Guides(3pm)				User Contributed Perl Documentation				  Mojolicious::Guides(3pm)

NAME
Mojolicious::Guides - Mojolicious guide to the galaxy DON'T PANIC! We are constantly working on new documentation, follow us on Twitter <http://twitter.com/kraih>, GitHub <http://github.com/kraih/mojo> or join the official IRC channel "#mojo" on "irc.perl.org" to get all the latest updates. LEARNING PERL
If you are new to Perl, we recommend Learn Perl in 2 hours 30 minutes <http://qntm.org/files/perl/perl.html> for a quick introduction, or the Modern Perl book <http://modernperlbooks.com/books/modern_perl/>, freely available in many formats. Both are excellent introductions to the language. For more books and documentation, check out learn.perl.org <http://learn.perl.org/>. TUTORIAL
Mojolicious::Lite A really fast and fun way to get started developing web applications with Mojolicious is the Mojolicious::Lite tutorial. Almost everything you learn there can also be applied to normal Mojolicious applications and is considered a prerequisite for the guides. You should definitely take a look! GUIDES
Mojolicious::Guides::Growing Starting a Mojolicious::Lite prototype from scratch and growing it into a well structured Mojolicious application. Mojolicious::Guides::Routing Simple and fun introduction to the Mojolicious router. Mojolicious::Guides::Rendering Generating content with the Mojolicious renderer. Mojolicious::Guides::Cookbook Cooking with Mojolicious, recipes for every taste. Mojolicious::Guides::FAQ Frequently asked questions with the right answers. Mojolicious::Guides::CodingGuidelines Coding guidelines and mission statement. A must read for developers and contributors! HIGHLIGHTS
Mojolicious and Mojolicious::Lite are the sum of many parts, small building blocks that can be used independently, these are the most prominent ones. Mojo::UserAgent Full featured non-blocking I/O HTTP 1.1 and WebSocket user agent. Mojo::DOM Very fun and minimalistic HTML5/XML DOM parser with CSS3 selector support. Mojo::JSON Minimalistic JSON implementation that just works. Mojo::Server::Daemon Highly portable non-blocking I/O HTTP 1.1 and WebSocket server with self-restart support through Mojo::Server::Morbo, perfect for development and testing. Mojo::Server::Hypnotoad Full featured UNIX optimized preforking non-blocking I/O HTTP 1.1 and WebSocket server with support for zero downtime software upgrades (hot deployment). Mojo::Server::CGI, Mojo::Server::PSGI Transparent CGI and PSGI support out of the box. Mojo::Template Very Perl-ish and minimalistic template system. Mojo::ByteStream Countless portable and very convenient bytestream manipulation methods. Mojolicious::Commands Pluggable command line system and the backbone of the mojo script. Test::Mojo Test driven development toolkit for web applications. ojo Fun oneliners using everything above. MORE
A lot more documentation and examples by many different authors can be found in the Mojolicious wiki at <http://github.com/kraih/mojo/wiki>. perl v5.14.2 2012-09-05 Mojolicious::Guides(3pm)