Child pages
  • Is projectdoc solving my documentation problem?


Short Description
My team and me are in a problem. We experience difficulties with out documentation. We do not know where to add new documents and cannot find information of interest in this big ball of wiki pages (or spaces). We know we have a problem, but cannot see what it is, let alone how to solve it! Can projectdoc help us?
Parent
Tags
Iteration
Production

Question

My team and me are in a problem. We experience difficulties with out documentation. We do not know where to add new documents and cannot find information of interest in this big ball of wiki pages (or spaces). We know we have a problem, but cannot see what it is, let alone how to solve it! Can projectdoc help us?

Answer

There is no easy solution for a complex problem, if the problem is not yet understood.

Users often have difficulties to organize their information collaboratively. Often nobody feels responsible to define a documentation concept that meets the requirements for the stakeholders (users, team members, management, ...). A wiki gives the promise that collaborative work will eventually result in a proper organization. But it is hard work and you have to discover the most suitable structure with your team.

projectdoc provides macros to help you define the templates for the documents you require. It further supports you to organize your document instances in your wiki space and make the space navigable. Have a look at Installed it! But my documentation did not get any better at the instance of installing! for hints on how you may start to use projectdoc for your documentation. But it all starts with an analysis of your stakeholder's requirements, your roles, and your content ...

If you are looking for advice on defining your information organisation, have a look at resources concerned with Information Architecture. Depending on your work there may already exists standards or quasi-standards to follow.

 

If you are looking for ways to organize your software architecture, have for instance a look at arc42.

projectdoc supports you to employ the selected standard in a Confluence wiki. We also provide free doctype add-ons that may get you started to define your own set of page and space blueprints.

 

Also check our Evaluation Topics to help you determine, if projectdoc is the right tool for you.