Hi Reed As we want to bridge the gap between developers and users and assist users to become (or engage more with) developers and developers to become better users, is it wise to repeat something you say "I've never seen it done well"?
My suggestion is that one adds to the 4 categories of developer documentation you list, 2 important documents: the "User Guide" and "Client Requirements Guide" to frame a more complete picture. Just like adjusting the size of the font to suit our visual needs when reading web pages, if the reader could adjust the documentation reading level to suit their information needs by clicking on the - or + signs like when viewing Google maps .... that would be cool! Then we truly would document requirements and knowledge from the library patron, the library staff and the amazing Koha developers all in one multi layered manual. Cheers, Irma CALYX -----Original Message----- From: koha-devel-boun...@lists.koha.org [mailto:koha-devel-boun...@lists.koha.org] On Behalf Of Reed Wade Sent: Friday, 19 March 2010 7:32 AM To: Koha Devel Subject: Re: [Koha-devel] Developer Documentation It's a thorny problem, there are several distinct classes of documentation and each are least worst served by different schemes. - style guides and other "how to do business" -- something formal but easy to edit like a well sorted wiki section with a designated caretaker to keep it nice - designs that are under discussion -- wiki pages under a section devoted to that activity - designs that are ratified -- something tamper resistant like a pdf (from docbook or ODT sources) - implementation details -- POD, inline docs made by the developer; release manager would review and could reject if missing I've never seen it done well if that helps. -reed _______________________________________________ Koha-devel mailing list Koha-devel@lists.koha.org http://lists.koha.org/mailman/listinfo/koha-devel _______________________________________________ Koha-devel mailing list Koha-devel@lists.koha.org http://lists.koha.org/mailman/listinfo/koha-devel
