You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
Version 1
Next »
Getting started with the projectdoc Toolbox is not easy. Some basic concepts are more than just good-to-know and the number of macros and doctypes may be simply overwhelming. This tip gives some advice on how to get started.
The projectdoc Toolbox is a collection of macros to make documentation work more easy. This is basically done by reuse of parts of other pages by the use of transclusion and by enhancing navigation by the use of dynamic lists of links.
Getting to learn projectdoc, a look at use and show cases may be helpful as a first step. But different people usually have different approaches to learn. Some may approach by learning concepts first and try them out later. Some prefer to play with the tools and learn concepts and details later. This tip shows some approaches you may choose - not necessarily in the order provided. 
Use Cases
Due to the generic nature of the macros, they can be applied in many areas of documentation work. For instance the following use cases are supported:
Show use cases ...
- Community of Practice
- Build an infrastructure to meet your requirements for a practicing community sharing interest in a given domain.
- Domain Crunching
- Collect and maintain information relevant for your team, project, or organization collaboratively.
- Exploratory Testing
- Run a time-boxed test session based on a test charter to answer questions of stakeholders.
- Glossary
- To work with a domain everybody needs to use the terms unerringly. Create a glossary to create a common understanding of your domains.
- Journals
- You want to track your findings? Either with your team or individual? The projectdoc Toolbox supports teams to create project or team journals and individual team members to keep a professional diary.
- Library
- Create a library for your project. Reference books, podcasts, videos, and other resources that provide information on the topics relevant for your project.
- Paperwork
- Collaborate to create documents for your stakeholders as a team.
- Product Documentation
- Provide information on how users work with your product. This includes information for users of all roles that interact with the product.
- Project Management
- Make all decisions, issues, and project relevant resources easily accessible for your team. This includes meeting minutes, stakeholder contact information, open issues, and identified risks with their mitigation strategy.
- Reporting
- Tag your documents and create reports on your documents in tabular form
- Service Management Documentation
- Communicate the necessary information on maintaining and using a service of your portfolio.
- Software Architecture Documentation
- Communicate the quality targets, context, and design drivers of your software architecture.
- User Documentation for Java Library
- Provide a standard documentation for users of a library for Java.
- User Documentation for Maven Plugin
- Provide a standard documentation for users of a plugin for Maven.
Show Cases
How the macros can be applied to spaces is provided as examples in our show cases:
Getting your Hands dirty ...
Learning projectdoc is best done by using it. To do so the projectdoc Toolbox provides a demo space to be created on your Confluence server.
This space explains a couple of projectdoc's concepts and - since the pages are editable in your space, makes it easy to see how it works and maybe play with its macros and pages.
There is also a Hands-on Tutorial to guide you through the process of creating some spaces and using tools from the toolbox by a step-by-step tutorial.
Learning by Tips
Tips show various aspects of the projectdoc Toolbox. It includes arbitrary, but important ways on how to use its tools.
The list contains a number of tips that originate from questions asked by customers.
One-on-Ones
If you would like to discuss your requirements with one of our team members, please schedule a 1:1!
In this session, typically an online chat or call about one hour long, we will discuss your topics and show how the projectdoc Toolbox can be used to organize your spaces.
