Go to start of metadata
- Created by Robert Reiner, last modified on 09. Oct 2019
A problem-centric introduction to a given problem. It is a learning tool to transfer knowledge. Usually provides references for further information to investigate related topics in greater detail.
- Tags
Topics of this Type
| Name | Short Description | Audience |
|---|---|---|
| Create a Space | Start with projectdoc by creating a space with the standard blueprint. | |
| Create an Index Space | Create an index space to learn what it is and what it is used for. | Documentation Architect, Author |
| Generic Categories | 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. | Author, Template Author, Documentation Architect, Documentation Gardener |
| Referencing Macros | Macros to help authors to reference other documents that are relevant to the current document. | Author, Template Author |
| Micro Structure | 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. | |
| Create a Personal Space | Adjust your Confluence personal space to work as a personal space for projectdoc. | Documentation Architect, Author |
| Structuring Macros | Macros to help authors to a document structure so that the information is easier to understand. | Author, Template Author |
| Using Roles | Add roles to your space and set the audience of a topic document to one of the roles. | |
| Aggregating Doctypes | 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. | Author, Template Author, Documentation Architect |
| Create a Workspace | Create a space to work on a given topic. This spaces uses an index space to reuse content. | Documentation Architect, Author |
| Home and Index Pages | 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. | |
| Modular Documentation Macros | Macros to support single sourcing for creating modular documents. | Author, Template Author |
| Doctypes in Detail | Learn about properties and sections of a document. | Documentation Architect, Author |
| Edit Display Table | 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 | |
| Modular Content Doctypes | Doctypes that help to write modular documentation and therefore support single sourcing. | Author, Template Author, Documentation Architect |
| Visual Macros | Macros to render information in a visually appealing format. | Author, Template Author |
| Add Display Table Macro | Authors use the Display Table Macro to list documents that match a query. This screencast shows how to add one to a document. | |
| Document Development Macros | Macros that help authors to create templates and content. | Author, Template Author |
| Documenting Doctypes | These are the generic working horses that are used whenever no specific doctype matches the intention of the author. | Author, Template Author, Documentation Architect |
| The Workhorse Macros | Learn about the central most heavily used macros of your projectdoc Toolbox. | Documentation Architect, Author |
| Add Excerpts to a Resource | 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. | |
| Categorization | Organize your spaces with generic and specialized categories. | Documentation Architect, Author |
| Collaboration Macros | Macros to support a team to write their documentation collaboratively. | Author, Template Author |
| Subordinate Documents | 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. | Author, Template Author, Documentation Architect |
| Specific Doctypes | 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. | Author, Template Author, Documentation Architect |
| Using Subdocuments | 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. | |
| What's next? | Checkout further resources on working with projectdoc. | Documentation Architect, Author |
| Generic Doctypes | What if no existing doctype matches the purpose of the document? Here are some tips how to handle this situation. | Author, Template Author, Documentation Architect |
| Using Subdocuments with Transclusion | Instead of a table listing the name and properties of the subdocuments, transclude the content into the parent document. | |
| Autolists | 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. | |
| Configure Servers | Shows how to configure servers as profiles. This makes it easy to select a deployment target by selecting a profile. | |
| Definition List Macro in Action | Screencast to show how the Definition List Macro is used to create definition lists in Confluence. | |
| Definition List Macro in Action | Screencast to show how the Definition List Macro is used to create definition lists in Confluence. | |
| Dynamic Property Values | Property values should only change when a document is saved. They should not be dependent on request-time. If they are, then they are called 'dynamic'. | Author, Documentation Gardener, Documentation Architect |
| Hands-on Tutorial | Get started with the projectdoc Toolbox: learning by doing | Documentation Architect, Author |
| Use Doctype Name as Border Image | 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. | Documentation Architect, Confluence Administrator, Documentation Gardener |
| Variables for Blueprints | The projectdoc Toolbox provides an interface for template authors to replace placeholders with space and context properties. | Template Author, Documentation Architect |
