The producer of a resource to be part of the documentation. The resource is typically a document or presentation, but may also be a prodcast or video.

Group
projectdoc-authors

The author creates documents and communicates information relevant for a project. The role is also part of a technical communicator, who is also seen as the user's advocate.

In the context of projectdoc, every team member my be in the role of an author. Even if the produced documents are only input for technical writers.

Resources

Name Short Description Doctype Audience
Get users started with collecting external information that is relevant for their project. Each piece of information is referenced by a resource document. Excerpts and quotes are used to catch detailed information and make it referenceable.
Tour
More than a short introduction, this tutorial introduces the need-to-know basics to get started with projectdoc.
Tour
Tour
Tour through the documentation for users who want to learn to create documents based on projectdoc doctypes.
Tour
Overview over the most relevant information for software developers to create their documentation on Confluence with the projectdoc Toolbox.
Tour
Learn how to access projectdoc properties via REST API with cURL.
Learn how to access projectdoc space properties via REST API with cURL.
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.
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.
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.
In addition to the properties specified in the document properties table, projectdoc provides additional properties drawn from Confluence or metadata.
Add a document as a child and automatically make supplied properties available in the parent.
Introduction to the autoconvert feature for URIs to external systems.
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.
Overview over the different categories of macros that are part of the Information Systems Extension.
Organize your spaces with generic and specialized categories.
Macros to support a team to write their documentation collaboratively.
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.
The Display Table Macro allows to render the values for a collection of properties for compact tables. With Version 4.5 this feature is also supported by the Tour Macro. This tip shows how to use it.
Discard unwanted references in manually compiled lists with the projectdoc Toolbox on Confluence.
Tools from the projectdoc Toolbox to import from and export to other information systems.
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 Display Table Macro provides a quick fix feature to control the width of the table columns.
Organized information of a context, such as a glossary or an address book, in a dedicated space. These spaces are called attachment spaces.
Create an index space to learn what it is and what it is used for.
Adjust your Confluence personal space to work as a personal space for projectdoc.
A step-by-step guide to create a glossary with the projectdoc Toolbox.
Create a space to work on a given topic. This spaces uses an index space to reuse content.
Deep links can be used on both sides of predicates in a Where Clause.
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.
Learn about properties and sections of a document.
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.
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.
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.
Introduces to the concept of content to be considered to be empty.
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.
What if no existing doctype matches the purpose of the document? Here are some tips how to handle this situation.
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.
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.
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.
List of macros linking to or transcluding from external information systems.
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.
Show how to use the Name List Macro to render links to glossary terms.
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.
Listing related pages to a page is quite easy using the projectdoc Toolbox.
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).
Doctypes that help to write modular documentation and therefore support single sourcing.
Macros to support single sourcing for creating modular documents.
Using sections and modules to organize and reference content.
Categories provide easy navigation. The category page documenting the category automatically lists all documents tagged with this category. A defined set of categories has per default no such homepage.
projectdoc documents typically provide a property named 'Parent Property'. This property refers to a logical parent. This tip shows what this is all about.
projectdoc is based on projectdoc documents. Creating a projectdoc document is easy: A projectdoc document is a Confluence page using document properties and sections.
projectdoc allows to group spaces and to set them in two kinds of relationships: delegate and search.
projectdoc introduces structure on a Confluence space. It adds the concept of homepages for document types.
Lists recognized system properties specified on the command line for starting the Confluence server.
Macros to help authors to reference other documents that are relevant to the current document.
Changing the rendered contents of a projectdoc document dynamically for each request.
Alter the rendering of macros of transcluded content with remote controls.
There are basically five ways to render navigation links with additional properties with the projectdoc Toolbox.
A short introduction on compiling projectdoc documents in dynamic lists using constraints.
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.
Lists the configuration options at space level.
Lists valid controls for properties to be used as space properties.
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.
Macros to help authors to a document structure so that the information is easier to understand.
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.
The projectdoc Toolbox makes it easy to search for documents with a given set of constraints in a document tree with a given root.
Show how to import properties from other projectdoc documents into a projectdoc document.
Tools from the projectdoc Toolbox to allow users to browse for information.
Links allow readers to find related information. Autocomplete allows authors to recall the names of related information. Let's have a closer look on the Autocomplete Feature of the projectdoc Toolbox!
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.
Learn about the central most heavily used macros of your projectdoc Toolbox.
To organize your documentation place documents in a typed repository and add additional views on demand.
Shows how to use the Wiki Link Macro based on Remote Controls to alternate between two different views on a single document.
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.
Shows how to transclude transcluded content.
Keeping track of transclusions using artificial properties.
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.
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.
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.
Add a document as a child and automatically make supplied properties and sections available in the parent. A short walk-through to use the Aspect Feature in your information architecture.
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.
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.
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.
Macros to render information in a visually appealing format.
Checkout further resources on working with projectdoc.