Blog

  • 2024
  • 2023
  • 2022
  • 2021
  • 2020
  • 2019
  • 2018
  • 2017
  • 2016
  • 2015
  • 2014
  • 2013
  • 2012

Tip on Sections

Today we added a new tip on

Section in Action

with the projectdoc Toolbox for Confluence.

This is the feature list for sections of the projectdoc Toolbox:

  1. Render only with Content
  2. Render dependent on ...
  3. Drag-and-Drop
  4. Transclusion
  5. Delegate Document
  6. Search Result
  7. Heading Numbering
  8. HTML H1/H2 deferred
  9. Suppress Title

For more information on sections, please refer to Section in Action!

What is projectdoc?

The projectdoc Toolbox is a collection of a large number of tools to help teams to create modular, agile documentation collaboratively and with fun. The toolbox is an add-on for Confluence and is available on the Atlassian Marketplace.

The tools in the projectdoc Toolbox consist basically of macros, doctypes, and a handful of conventions. The number of these tools is overwhelming, especially for new users.

One Tip at a Time

Learning a new tool is not easy because users need to get their tasks done. Learning a new tool takes time, time that is not available.

Learning by tips - one tip at a time

Users learn some interesting aspects of projectdoc by reading one tip at a time. The tips show aspects of projectdoc and link to resources to learn more about a specific top - just in case.

Feedback welcome!

If you have questions or comments, please get in touch!

Tip on Using Transclusions

Today we added a new tip on

Content Reuse

with the projectdoc Toolbox.

The tip lists features that help to reuse metadata and sections with transclusion (or excerpts in the Confluence lingo).

Teams need to use their resources wisely. Customers of software often value new features more than qualities that are not so easily perceptible. And this may hold true for all industries.

One of these qualities that are neither easy to explain to customers nor achievable without team effort is evolvability. What keeps the product owner in the position to quickly respond to changes on the market?

It boils down to have a good metaphor for your software, its architecture and artifacts. A good metaphor allows effective communication, supporting to demand minimal documentation.

Minimizing resources spent for documentation by reuse is one option. But reuse is a two-edged sword. You may hurt your project with two sides if you are reusing code without a strategy to evolve the modules and interfaces. The same is true with the reuse of documentation. You have to define the modules for reuse and - as a team - keep an eye on which documents are reusing which modules.

The projectdoc Toolbox defines documents as Confluence pages with properties and sections. Information from properties and sections can be easily transcluded with a number of macros in the toolbox. While properties are simply referred to by their name, sections may be identifier by their title (which may be overridden by a stable identifier) or tags.

There are many use cases where authors may want to transclude multiple content from one document or from multiple documents. The projectdoc Toolbox handles required adoption of the heading levels of the transcluded content.

For more information on this topic, please refer to the tip Content Reuse.

What is projectdoc?

The projectdoc Toolbox is a collection of a large number of tools to help teams to create modular, agile documentation collaboratively and with fun. The toolbox is an add-on for Confluence and is available on the Atlassian Marketplace.

The tools in the projectdoc Toolbox consist basically of macros, doctypes, and a handful of conventions. The number of these tools is overwhelming, especially for new users.

One Tip at a Time

Learning a new tool is not easy because users need to get their tasks done. Learning a new tool takes time, time that is not available.

Learning by tips - one tip at a time

Users learn some interesting aspects of projectdoc by reading one tip at a time. The tips show aspects of projectdoc and link to resources to learn more about a specific top - just in case.

Feedback welcome!

If you have questions or comments, please get in touch!

We are happy to announce a new release of  the smartics Enforcer Rules for Maven 1.0.1!

The smartics Enforcer Rules provides a collection of rules for the Maven Enforcer Plugin.

This is a bugfix release to deal with BOM imports in the dependency management with a snapshot version. While it is no problem if the BOM contains at least one snapshot dependency, the previous versions failed if it did not.

Today we added a new tip on

Define Status Tags

with the projectdoc Toolbox.

The use case is that teams need to define a set of valid property values and support authors to select one of these values. The projectdoc Toolbox makes it easy to apply CSS styles to a define property value.

What is projectdoc?

The projectdoc Toolbox is a collection of a large number of tools to help teams to create modular, agile documentation collaboratively and with fun. The toolbox is an add-on for Confluence and is available on the Atlassian Marketplace.

The tools in the projectdoc Toolbox consist basically of macros, doctypes, and a handful of conventions. The number of these tools is overwhelming, especially for new users.

One Tip at a Time

Learning a new tool is not easy because users need to get their tasks done. Learning a new tool takes time, time that is not available.

Learning by tips - one tip at a time

Users learn some interesting aspects of projectdoc by reading one tip at a time. The tips show aspects of projectdoc and link to resources to learn more about a specific top - just in case.

Feedback welcome!

If you have questions or comments, please get in touch!

We are happy to announce a new release of  the smartics Enforcer Rules for Maven 1.0!

The smartics Enforcer Rules provides a collection of rules for the Maven Enforcer Plugin.

Not much has changed since the last release: there are still two rules.

We moved the project to GitHub and made it available on Maven Central to make it much easier to use these rules in your builds. Therefore we decided to jump to the major version of '1'.

Also note that we moved the documentation for the rule set from the site to the product's homepage on our wiki. Using the projectdoc Toolbox this new location for the homepage makes it easier for us to change the documentation independently from the release cycle of the code.

Enforcer rules provided by this release:

RuleShort Description
No cyclic Package Dependency Rule
Checks for package cycles.
No SNAPSHOTs in Dependency Management Rule
Checks for SNAPSHOT dependencies in the dependency management block of a Maven POM.

 

The projectdoc Toolbox is a collection of a large number of tools to help teams to create modular, agile documentation collaboratively and with fun. The toolbox is an add-on for Confluence and is available on the Atlassian Marketplace.

The tools in the projectdoc Toolbox consist basically of macros, doctypes, and a handful of conventions. The number of these tools is overwhelming, especially for new users.

Today we added a new tip on

Using Space Properties

with the projectdoc Toolbox. Using space properties might introduce some complexity to your space configuration, but adds a lot of possibilities to use variables in your pages.

What is projectdoc?

The projectdoc Toolbox is a collection of a large number of tools to help teams to create modular, agile documentation collaboratively and with fun. The toolbox is an add-on for Confluence and is available on the Atlassian Marketplace.

The tools in the projectdoc Toolbox consist basically of macros, doctypes, and a handful of conventions. The number of these tools is overwhelming, especially for new users.

One Tip at a Time

Learning a new tool is not easy because users need to get their tasks done. Learning a new tool takes time, time that is not available.

Learning by tips - one tip at a time

Users learn some interesting aspects of projectdoc by reading one tip at a time. The tips show aspects of projectdoc and link to resources to learn more about a specific top - just in case.

Feedback welcome!

If you have questions or comments, please get in touch!