OpenWack Community Software Blog

The best free community software highlighted

Reference and Documentation writing started

Author: Emil | Published: Jun 1st, 2009
Category: Documentation

While development we use technical specifications for writing code with schemas, drawings, sketches and text. Tomorrow we start laying down proper documentation based on the references we use ourselves.

We realize that some things change right on the road and we will have to rewrite some parts together with the code but the absolute majority of this material is going to stay there. We want to keep this process running along the development because of 2 reasons:

1) It’s just much easier to contribute to documentation writing in small parts using our own references and putting for you what have been magically turned into working code. So it’s not like a damned abyss of work to write the whole thing when the fun part (development) is done.

2) You will have complete reference in the end because it’s being forged right on the dev assembly line and covers particularly anything that is being actually developed.

We understand that nobody wants to read manuals and that is why we will do everything to make it not critical for you to start using/developing for OpenWack. On the other hand, any open source project needs to have sufficient technical reference and manuals to attract rock-star plugin developers. Who is going to dedicate their time to your project if you can’t even describe it properly? We are definitely determined to avoid this question. ;)

Update: We have set up documentation wiki here: docs.openwack.org. This is what will be used by the development team and later by plugin developers and theme designers. Watch it getting filled with the documentation, references, specifications and howtos.

Leave a Reply

© 2009 OpenWack Community Software Blog. All Rights Reserved.