Hi everyone,
I'm setting up a wiki to document software designs in my department, and I'm wondering what the best way is to structure things. We have several software products, each with several versions.
I could structure namespaces something like this:
product 1 : version 1 : all pages for version 1
product 1 : version 2 : all pages for version 2 including all pages for version 1
in this case, when version 2 is developed, we'd essentially duplicate version 1's pages into the new version 2 namespace, then we'd change version 2's content as needed. The problem with this method is that since we actively develop both versions, if we make a change to version 1 that version 2 would inherit, we'd have to update the wiki in two places.
I could also structure the wiki like this:
product 1 : pages for all versions
In this case, maybe sections detailing the design for each version would reside all on one page, or there'd be only one section if the design is consistent across all versions. So for example:
===== Design for Showing a List of Customers =====
This page details the screen that displays customers.
==== Version 1.0 ====
(design for version 1)
==== Version 2.0 ====
(changes that were made to version 1's design, if any)
The advantage here is that if a design change occurs to version 1 that is inherited by version 2, you may only have to update the wiki in one place.
What works best for you guys? Is it better to break apart the content by product and version, or combine everything onto one page, or ...?
Thank you, I'm eager to read what works for other Dokuwiki users!
Jeff