projectdoc Toolbox

Topic Index

List of all topics.

Name Short Description Parent
Document types (or doctypes for short) define a set of properties and sections. Each doctype matches at least one Confluence Page Blueprint. Confluence Page Blueprints are a collection of templates, but often the collection contains only one element.
Properties are metadata that can be added to every projectdoc document. If you require a set of metadata for each instance of a document type, you should write your own doctype.
The main body of a document is divided into sections. Besides the sections defined by a doctype, an author may add any number of additional sections. Sections that are regularly added to a given doctype should be added to the doctype's template.
Provides a basic set of doctypes to create agile documentation.
A short introduction to developer diaries.
The purpose and the differences between the name and title property of a doctype.
Explains the differences between and commonalities of the Confluence Page Properties and the projectdoc Toolbox Document Properties.
Benefits of and tips on writing short descriptions.
Explains the differences between and commonalities of the Confluence Excerpt and the projectdoc Toolbox Transclusion features.
Explains the differences between and commonalities of the Confluence Code Block Macro and the projectdoc Toolbox Code Block Placeholder Macro.
Techniques to tag content with arbitrary labels: Tags, Labels, Flags, and Selectors.
Lists features of the projectdoc Toolbox according transclusion of text content that is stored on remote information system. Macros to transclude content provided by Confluence out-of-the-box are compared to these features.
Sort keys help to control the sort order of a set of documents. This order seems to come magical for users, since the sort key is usually not displayed. The order establishes a path to a set of documents displayed as a list as the result of a query.
Discussion on whether or not to use more than one heading on level 1.
A short introduction into the concepts and features of the projectdoc Toolbox.
References are links to information that back up the information in this document. Resources refer to additional information to the topic discussed in the document and related information.
Compare the way of creating and maintaining sections in Confluence with and without the projectdoc Toolbox.
Create an index space to learn what it is and what it is used for.
Start with projectdoc by creating a space with the standard blueprint.
Provides doctypes to create documentation in software development projects. The focus is on documenting the architecture of the product, but it includes templates for other software development documentation requirements as well.
Categories that are defined to be used with any doctype. So any document instance defined for these categories has to make sense for any doctype.
projectdoc is based on projectdoc documents. Creating a projectdoc document is easy: A projectdoc document is a Confluence page using document properties and sections.
Software documentation is a large field to communicate with different stakeholders with different information needs. This topic introduces to the basics of documenting a project with a wiki.
Macros to help authors to reference other documents that are relevant to the current document.
A short introduction on how the doctype is intended to be used to work with OKRs.
Provides doctypes to document a system or software architecture based on the arc42 Template.
How to create a space to start documenting your software architecture or software system using the projectdoc Toolbox for Confluence and additional free add-ons.
A template assists authors in writing documents of a given type. Templates help that documents are similar in structure and therefore are also easier to read by members of the project team. projectdoc only renders table rows and sections, if they actually contain information. This reduces clutter to distract readers.
projectdoc introduces structure on a Confluence space. It adds the concept of homepages for document types.
Adjust your Confluence personal space to work as a personal space for projectdoc.
Provides doctypes to collborate with your team. Run iterations and record discoveries that may be of interest at the end of the iteration or for even later reference. Quick notes are more easily added as records to the team's space than to the official documentation tree. Defer the talk to the documentation architect to the end of the iteration (if the discovery is still of interest).
projectdoc allows to group spaces and to set them in two kinds of relationships: delegate and search.
How to start your software project documentation? Here are the steps to get started with Confluence and the projectdoc Toolbox.
Macros to help authors to reference other documents that are relevant to the current document.
Categories that are defined to be used for a specific doctype. May be used for a couple of doctypes, but is not intended to make sense for any doctype.
Add roles to your space and set the audience of a topic document to one of the roles.
Provides doctypes to organize the developer's work by the employment of a diary. Take you personal planning and professional records to the next level!
A collection of blueprints for Confluence to create and work with documentation for Java projects.
A collection of blueprints for Confluence to create and work with documentation for Maven projects.
Doctypes to help organize the space. This includes homepages for particular information (like the homepages for each doctype) and tours that provide a specific view on existing documentation.
Create a space to work on a given topic. This spaces uses an index space to reuse content.
Provides doctypes to define the checklists, processes, patterns, tools, and rules your team agrees upon. Writing them down makes them accessible for anyone - especially for new team members. Keep these documents short and to the point!
Home and index pages help to organize documents by type. For each doctype there is a homepage and and index page. The homepage shows the central documents that are added to it (immediate children). Index pages list all documents of the space, regardless of their location.
Macros to support single sourcing for creating modular documents.
Mission, vision, strategy for business planning and execution.
Provides doctypes to document services and systems for IT service management (ITSM).
Learn about properties and sections of a document.
The Display Table Macro allows to specify queries on documents. The documents are listed in a tabular form per default. Authors declare the document properties to be displayed in the columns of the table
Doctypes that help to write modular documentation and therefore support single sourcing.
Macros to render information in a visually appealing format.
Authors use the Display Table Macro to list documents that match a query. This screencast shows how to add one to a document.
Provides doctypes for documenting decisions, risks, open issues, and meeting minutes.
Provides doctypes for documenting and tracking risks.
Macros that help authors to create templates and content.
These are the generic working horses that are used whenever no specific doctype matches the intention of the author.
Learn about the central most heavily used macros of your projectdoc Toolbox.
Resources describe relevant information for a project. The essential parts are noted to make it easier for finding the most relevant parts quickly. Excerpts allow to add the information as subdocuments.
Organize your spaces with generic and specialized categories.
Macros to support a team to write their documentation collaboratively.
Document macros, page blueprints, space blueprints, and components of your Confluence add-on.
Subdocuments are associated with the lifetime of the parent document. The section doctype is the most generic type of document, but there are others, that are specific to a certain doctype.
Use products (templates) from the V-Modell®XT in your Confluence wiki as blueprints!
A list of doctypes that have a specific purpose. The core doctypes are none-the-less quite generic so that they can be used in almost any project.
The lifetime of a subdocment is associated with that of its parent. Subdocuments help to organize content within a document by externalizing it. This makes it easier for teams to work on a document together. Referencing parts of the document is also easier.
Checkout further resources on working with projectdoc.
What if no existing doctype matches the purpose of the document? Here are some tips how to handle this situation.
Instead of a table listing the name and properties of the subdocuments, transclude the content into the parent document.
Autolist macros allow to display a list of documents dependent on a set of properties. This screencast shows how to use the Display Table macro to select all documents tagged with a given keyword.
Use or define page blueprints with properties / metadata and sections that render only if they actually contain information. Use or define space blueprints with homepages for document types for dynamic organization.
Index spaces provide basic configuration via space properties and homepages for commonly used document types.
Space properties that need to be seen by all spaces are defined in the index space.
Organize information about persons and organizations.
Index spaces also define generic types that are used by all doctypes.
Index spaces define type-specific types that are commonly used throughout spaces.
A library space holds resources in a separate repository.
Document type homepages in the index space serve as automatic homepages if the current space lacks a homepage for that document type.
Attachment space for defining or describing terms of one or more domains.
A sample space for the collaboration of an agile team.
A sample space for tracking skills of members of an organization.
Use rich multi-excerpts (transclusion) for content reuse - even from page result lists. Replace parameters in excerpts. Include properties and sections from pages. Hide content dependent on roles and properties.
Add new content to be dynamically listed in existing documents. Create complex property reports with a Select-From-Where syntax. Transclude or link to texts fragments and images locally or on remote servers.
Learn how to access projectdoc properties via REST API with cURL.
Learn how to access projectdoc space properties via REST API with cURL.
Add HTML meta tags to your Confluence pages. This is for the search engine optimization (SEO) for your website as well as adding semantics for machine reading.
Sometimes you need to add properties to a set of documents in a given context. This can be handled in two ways: add the property to each document or use the Tour Macro.
Agile documentation is not another buzzword. There is actually a set of rules to follow which will lead to meaningful documentation. Writing helpful documentation is not easy, but it gets a lot easier with the agile mindset - and with the projectdoc Toolbox.
The projectdoc Toolbox makes it easy to search for documents with a given set of constraints in an ancestor context.
It is pretty easy to annotate dynamic lists with the projectdoc Toolbox on Confluence.
A promotion to celebrate arc42's anniversary!
In addition to the properties specified in the document properties table, projectdoc provides additional properties drawn from Confluence or metadata.
Introduction to the autoconvert feature for URIs to external systems.
Prefix the title with an automatically incremented identifier.
Automatic lists are part of every Confluence instance. Especially the Dashboard lists all recent changes automatically. And there are macros to list documents by label and other properties. The projectdoc Toolbox supports queries on any properties defined for your documents. This allows you to provide lists of references to your readers that are relevant in a given context.
Concepts central to projectdoc. Things users have to understand to get the most out of using projectdoc.
Authors occasionally need to have a look at a page as if they where in the role of a reader. The pretend-being-a user space property supports switching roles. With the use of the Web API Extension and the Bookmarklets Extension switching roles is now really easy!
Lists the configuration options for template authors to control page creation.
Add-on to extend the Toolkit with Bookmarklets. Allows to execute tools via the browser.
projectdoc documents are stored in caches for quick access. Users may want to clear one of these caches.
Overview over the different categories of macros that are part of the Information Systems Extension.
Colored sections or boxes – like the Confluence panel macro – support authors to emphasize their content.
Tables often require a lot of space to be rendered. This tip shows how to reduce the demand of space.
Discard unwanted references in manually compiled lists with the projectdoc Toolbox on Confluence.
Compare the features provided by the projectdoc Toolbox with features that come with Confluence out-of-the-box.
Tools from the projectdoc Toolbox to import from and export to other information systems.
The use of the Create-from-Template Macro in the projectdoc blueprints may be a bit confusing, especially for new users. Here we provide some insight into what may trouble you -- without knowing in first place.
The projectdoc Toolbox provides a number of features to help teams to reuse content. Content can be transcluded individually or in form of a multitransclude. Authors can even transclude content from multiple documents in the wiki, effectively combining transclusion with automatic lists.
The main purpose of content providers is to add additional context entries for the blueprints provided by an add-on. projectdoc defines a number of context providers to be used by add-on developers.
The Display Table Macro provides a quick fix feature to control the width of the table columns.
The recommended way of creating a diary with the Developer's Diary Add-on is to add a page with the Diary Template in one's Personal Space.
A step-by-step guide to create a glossary with the projectdoc Toolbox.
A short introduction the the Doctype Maven Plugin to generate Confluence Blueprints for projectdoc Doctypes based on an XML description.
Lists CSS selectors provided by the projectdoc Toolbox to apply styles.
Doctypes and the Name List Macro allow to specify a range of valid tokens for a value. These values can be rendered by applying specific CSS styles.
Screencast to show how the Definition List Macro is used to create definition lists in Confluence.
A gentle introduction to page blueprints provided by doctype add-ons. The page blueprints are grouped semantically to make it easier for users to build a conceptual mind map for them.
List of all doctypes provided by add-ons. Provides an overview over doctype IDs and blueprint keys.
A view on documentation to locate types of documents.
We like to think of document properties as metadata. But in some contexts it is natural to think of them as data for the entity described by the document.
Lists valid controls for properties to be used in document properties tables.
Categories, tags, and others allow to organize the pages in your wiki. First define categories pages with display table macros. Second tag your pages with these categories. With this two-step process it is easy to have multiple views to link to your information in your wiki.
Provides information about features potential users should consider for their evaluation process on using the projectdoc Toolbox for Confluence.
Export document properties as metadata to the rendered HTML page.
Information on how to use the fragments cache.
Short introduction on using data tables or using views on data.
Add-on to extend the projectdoc Toolbox for drawing document graphs.
Get started with the projectdoc Toolbox: learning by doing
Reusing sections typically includes the transcluded content to match the document structure of the transcluding document. The projectdoc Toolbox does this automatically.
Lost in wiki space? Blank-Wikipage-Syndrome? Where to add? How to find? No fun anymore?
There is no one-size-fits-all for documenting software projects. What we do is giving you an introduction on how to get started with the projectdoc Toolbox and the Software Development Add-on to define your documentation requirements with Confluence.
The Information Systems Extension for the projectdoc Toolbox allows to render a link with the HTML title as label via autoconvert of the pasted URL.
Writing page blueprints includes to configure wizards for easy page creation. If the field identifier contains dots there is a problem with a simple solution.
A short introduction using the impersonator feature of the projectdoc Toolbox. In this example we examine what to do to reuse a layout defined in another document.
Shows how to import properties from another document to be applied to placeholders in transclusions.
If you have lots of projectdoc documents then the in-memory properties cache might not perform optimal.
You may want to provide information for specific audiences.
List of macros linking to or transcluding from external information systems.
Add-on to extend the projectdoc Toolbox to integrate remote information systems.
Installing the projectdoc Toolbox on Confluence is very easy.
Provides information to get new users of projectdoc get started with projectdoc documents and spaces.
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.
projectdoc provides a number of artificial properties for documents. Spaces may inherit properties from delegate spaces. All properties can be accessed by macros of the toolbox.
Lists all services provided by the Web API Extension.
Listing related pages to a page is quite easy using the projectdoc Toolbox.
Integrate information from different sources into your documentation using Confluence and the projectdoc Toolbox.
Using projectdoc with a non-supported locale (language) works, but lacks some of its features. This short topic provides some details on this matter.
This is a gentle introduction to the core macros. The macros are grouped semantically to make it easier for users to build a conceptual mind map for them.
Using existing properties from other documents.
Add-on to extend projectdoc for Confluence with Maven Tools.
Import project information from Maven POM files. Provides information about required configuration to get this import running.
References listed in tables and lists may come from different sources. The Table Merger Macro allows to render a number of tables (or lists) as one table (or list).
Using sections and modules to organize and reference content.
Have you ever experienced performance problems with your Confluence on premise (Server) installation? This tip might help you.
The projectdoc Toolbox does not support dynamic values as property values. Use sections to render dynamic values and select the contents of this section instead of property values.
It is often obvious that the introduction text is a description of the information of the document. Therefore the title 'Description' or 'Summary' may be irrelevant. You may suppress the rendering of the title easily.
Templates are a great tool to make creating and maintaining documents very easy. Blueprints support authors to create documents based on templates. But a large number of blueprints may make it difficult for authors to select the appropriate template. Here are a few tips on dealing with larger amounts of blueprints.
The pages wizards provide placeholder to make page creation easier.
projectdoc documents typically provide a property named 'Parent Property'. This property refers to a logical parent. This tip shows what this is all about.
Doctype add-ons provide space and page blueprints based on macros from the projectdoc Toolbox.
Extensions augment the projectdoc Toolbox. Features that are not relevant for all users are separated and may be installed on-demand by customers of the Toolbox.
Screencasts to introduce to the concepts and workings of projectdoc. Users get an impression on how projectdoc works and find information on its concepts.
Lists recognized system properties specified on the command line for starting the Confluence server.
The online manual for version 1 of the projectdoc Toolbox for Confluence.
Lists projects that use the projectdoc Toolbox for their documentation. We include real projects as well as interesting examples.
Properties are not updated transitively. Users may refresh documents via page tools.
Reusing type instances for documents.
Changing the rendered contents of a projectdoc document dynamically for each request.
There are basically five ways to render navigation links with additional properties with the projectdoc Toolbox.
Rescue and restore data of a Confluence page that does not render anymore.
To access Confluence via its REST API with cURL you typically need to authenticate. Learn how to login with cURL and avoid some common security pitfalls.
Define the default search space for index spaces.
Tips on specifying search queries for Lucene. This also applies to projectdoc's query macros.
Use the Section Macro to define sections. This tip introduces the macro by listing its features.
Define a doctype on document instances to select from its set of values.
A set of Confluence spaces showing projectdoc in action.
Lists the configuration options at space level.
Lists valid controls for properties to be used as space properties.
Provides a gentle introduction to the concept of spaces using projectdoc.
It is easy to define the default homepage for a given doctype in a space.
Information on how to apply styles to your space using the OKRs doctype add-on.
The projectdoc Toolbox makes it easy to search for documents with a given set of constraints in a document tree with a given root.
Tools from the projectdoc Toolbox to allow users to browse for information.
Describes how the system calculates the URI to an information system based on its identifier.
Properties may represent an editable boolean value. Use Confluence tasks to define the value for those properties.
To investigate on a topic or to create a positioning paper collaboratively with a team, a workspace is a handy tool. Information is collected and arranged and the results may be exported to a PDF to be send to interested stakeholders.
Instead of creating a new document instance for a doctype, the template button macro only logs an error to the browser's console.
List of variables provided in the blueprint context for templates.
The Content Marker Macro identifies content that can be displayed using the Display Table Macro. This is a short tip on how to transclude content from a projectdoc document.
Starting with the projectdoc Toolbox might be intimidating at first. So start small using the basic features and add what is needed, when it is needed.
To organize your documentation place documents in a typed repository and add additional views on demand.
List of tips to use Confluence with projectdoc and fun!
Despite the name of the Topic Doctype, it is not supposed to be used for any topic. Use the Generic Doctype or the Section Doctype for general purposes.
Tracking team mood (or excitement) can be tracked by the use of the Display Table Macro and the Confluence Chart Macro.
Shows how to transclude transcluded content.
Keeping track of transclusions using artificial properties.
List of issues encountered with the projectdoc Toolbox and solutions or workarounds to resolve them.
To completely reestablish the projectdoc document index the Lucene index is required to be rebuilt and the projectdoc document cache needs to be cleared.
The projectdoc Toolbox provides a lot of macros to create documentation. It also replaces two macros provided by Confluence. The Excerpt Macro and the Page Properties Macro.
An overview over the use cases for which the projectdoc Toolbox provides support.
A collection of macros supports dynamic parameters that may be controlled remotely or by their context. This tip provides some information on context controlled macros.
If you want to list a reference to a document with name and short description, use the Display Properties Macro. If you specify no property names, it defaults to Name and Short Description.
It is easy to list all pages that transclude a section from the current page. This allows you, as an author, to check quickly if changes to a document that is transcluded, needs changes to the transcluding documents.
With the doctypeBorderImageServlet and some custom CSS it is possible to render a border image that contains the doctype name of the currently displayed Confluence page.
Quotes automatically collect information provided in resources or from an associated excerpt of a resource. This makes it easy for you to quote text. Simply add the Quote Macro, set the page. Associating the metadata of the resource to form a quote is taken care of by projectdoc.
Property values are inherently considered to be a list of strings. Typically this a good thing since it makes working with list of names very easy. Sometimes it makes things more difficult.
A short introduction to use heading numbers with the projectdoc Toolbox.
An overview over features employing placeholders to create a modular documentation.
We decided to move our documentation from the XDoc format to projectdoc on Confluence. This allows us to update the information independent of the release cycles of the products. Here are some tips on how to use projectdoc for this task.
Space properties are defined for spaces and are accessed via the Space Property Macro. This tip goes into detail in how to use space properties with inheritence and extension pages.
A short introduction on using spaces with the projectdoc Toolbox for Confluence.
The projectdoc Toolbox provides an interface for template authors to replace placeholders with space and context properties.
A short introduction on how to work with different versions of documentation for a Maven plugin.
A short introduction on how to work with different versions of documentation for a Java library.
Switch views on documents dependent on the user's role by setting space properties in the user's homepage.
projectdoc makes it easy to create a modular documentation and provide multiple views on topics.
Add-on to extend projectdoc with an API to access on the web.
The projectdoc Toolbox makes it easier to create links for navigation for users to browse the documentation. This tip explains some the concept in the context of organization, person, role, and stakeholder.

Central Topics

Need more Info?

More information on doctype:

Index Views for Topics
Related Information

Related information in your wiki:

  • No labels