MobileRead Forums - View Single Post

Valloric · 08-03-2009, 09:26 AM

Sigil definitely needs some documentation. Although an offline version should be available and is planned, IMO the best documentation is always online since it can be updated even between releases. Google code provides all projects with wiki pages. Sigil's pages can be found here (there is not much there now).

I'd like members of the MobileRead community to help write some docs for Sigil: best practices, guides on getting things done, etc. Whatever you think is necessary. The reasons why I'm asking for community help follow:

The more time I spend writing docs, the less time I spend writing code;
The community has already produced some wonderfull guides and tutorials for various tools, including other ebook editors;
People who want to contribute to the project but don't know how to code now have a way of helping out.

Anyone interested can respond here and I'll add them as contributors to Sigil on it's project page. You'll need a Google account.

08-03-2009, 09:26 AM	#1
Valloric Created Sigil, FlightCrew Posts: 1,982 Karma: 350515 Join Date: Feb 2008 Device: Kobo Clara HD	Documentation for Sigil Sigil definitely needs some documentation. Although an offline version should be available and is planned, IMO the best documentation is always online since it can be updated even between releases. Google code provides all projects with wiki pages. Sigil's pages can be found here (there is not much there now). I'd like members of the MobileRead community to help write some docs for Sigil: best practices, guides on getting things done, etc. Whatever you think is necessary. The reasons why I'm asking for community help follow: The more time I spend writing docs, the less time I spend writing code; The community has already produced some wonderfull guides and tutorials for various tools, including other ebook editors; People who want to contribute to the project but don't know how to code now have a way of helping out. Anyone interested can respond here and I'll add them as contributors to Sigil on it's project page. You'll need a Google account.