Organizes the documentation for a given project. The architect is responsible to recognize the stakeholders communication needs and create the appropriate infrastructure.

Group: projectdoc-documentation-architects

Description

The documentation architect is a specialized information architect who specializes in the communication needs between stakeholders of a (software) project.

Documentation

Documentation relevant to people with this role.

Name	Short Description	Doctype	Audience
Collecting Information	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	Documentation Architect, Author
Tour for Software Developers	Overview over the most relevant information for software developers to create their documentation on Confluence with the projectdoc Toolbox.	tour	Documentation Architect, Author, Documentation Gardener
Tour for Template Authors	This is a tour through the documentation for users that want to design their own set of templates or just want to create one or two templates.	tour	Template Author, Documentation Architect
Accessing projectdoc Properties with cURL	Learn how to access projectdoc properties via REST API with cURL.	topic	Author, Documentation Architect, Documentation Gardener
Accessing projectdoc Space Properties with cURL	Learn how to access projectdoc space properties via REST API with cURL.	topic	Author, Documentation Architect, Documentation Gardener
Add HTML Meta Tags	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.	topic	Documentation Architect
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.	topic	Author, Template Author, Documentation Architect
Agile 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.	topic	Documentation Architect, Documentation Gardener, Author, Template Author
Artificial Properties	In addition to the properties specified in the document properties table, projectdoc provides additional properties drawn from Confluence or metadata.	topic	Author, Documentation Architect, Documentation Gardener
Aspects light	Add a document as a child and automatically make supplied properties available in the parent.	topic	Documentation Architect, Documentation Gardener, Template Author, Author
Autoconvert Information System URIs	Introduction to the autoconvert feature for URIs to external systems.	topic	Author Documentation Architect Documentation Gardener
Auto Increment in Title	Prefix the title with an automatically incremented identifier.	topic	Documentation Architect, Template Author
Basic Concepts and Conventions for projectdoc	Concepts central to projectdoc. Things users have to understand to get the most out of using projectdoc.	topic	Author, Documentation Architect, Documentation Gardener, Template Author
Blueprint Properties	Lists the configuration options for template authors to control page creation.	topic	Template Author, Documentation Architect, Documentation Gardener
Categories of Information System Macros	Overview over the different categories of macros that are part of the Information Systems Extension.	topic	Author Documentation Architect Documentation Gardener
Categorization	Organize your spaces with generic and specialized categories.	topic	Documentation Architect, Author
Changing Names	A name in projectdoc used to identify a document is not considered a hard reference. When changing the name of a particular document, the references to the original name do not automatically change. This is by design. It may also by the cause of annoyance. This tip provides information how to deal with this.	topic	Documentation Gardener Documentation Architect
Colored Sections and Boxes	Colored sections or boxes – like the Confluence panel macro – support authors to emphasize their content.	topic	Author, Template Author, Documentation Architect
Configuration	Information for the configuration options of the projectdoc Toolbox.	topic	Confluence Administrator, Documentation Architect, Documentation Gardener
Confluence as the Information Hub	Tools from the projectdoc Toolbox to import from and export to other information systems.	topic	Documentation Architect, Author
Content Reuse	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.	topic	Author, Documentation Gardener, Documentation Architect
Context Provider	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.	topic	Template Author, Documentation Architect
Create an Attachment Space	Organized information of a context, such as a glossary or an address book, in a dedicated space. These spaces are called attachment spaces.	topic	Documentation Architect, Author
Create an Index Space	Create an index space to learn what it is and what it is used for.	topic	Documentation Architect, Author
Create a Personal Space	Adjust your Confluence personal space to work as a personal space for projectdoc.	topic	Documentation Architect, Author
Create a Project Glossary	A step-by-step guide to create a glossary with the projectdoc Toolbox.	topic	Documentation Architect, Author
Create a Workspace	Create a space to work on a given topic. This spaces uses an index space to reuse content.	topic	Documentation Architect, Author
CSS Styles	Lists CSS selectors provided by the projectdoc Toolbox to apply styles.	topic	Documentation Architect, Confluence Administrator
Deep Links in Queries	Deep links can be used on both sides of predicates in a Where Clause.	topic	Author, Template Author, Documentation Architect, Documentation Gardener
Define Status Tags	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.	topic	Author, Template Author, Documentation Architect, Documentation Gardener
Doctypes in Detail	Learn about properties and sections of a document.	topic	Documentation Architect, Author
Documenting Doctypes	These are the generic working horses that are used whenever no specific doctype matches the intention of the author.	topic	Author, Template Author, Documentation Architect
Document Property Controls	Lists valid controls for properties to be used in document properties tables.	topic	Author, Documentation Architect, Documentation Gardener
Dynamic Property Value Handling	Configuration to control how the projectdoc Toolbox handles property values with dynamic content.	topic	Confluence Administrator, Documentation Architect, Documentation Gardener
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'.	topic	Author, Documentation Gardener, Documentation Architect
Empty Content	Introduces to the concept of content to be considered to be empty.	topic	Documentation Architect, Template Author, Author
Filter on Table Rows	The projectdoc Toolbox for Confluence provides a macro to merge tables. The macro also allows to filter on table rows. This tip provides a short overview.	topic	Documentation Architect, Documentation Gardener
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.	topic	Author, Template Author, Documentation Architect, Documentation Gardener
Generic Doctypes	What if no existing doctype matches the purpose of the document? Here are some tips how to handle this situation.	topic	Author, Template Author, Documentation Architect
Hands-on Tutorial	Get started with the projectdoc Toolbox: learning by doing	topic	Documentation Architect, Author
Heading Level Transposition	Reusing sections typically includes the transcluded content to match the document structure of the transcluding document. The projectdoc Toolbox does this automatically.	topic	Documentation Architect, Author
How to document a Software Development Project	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.	topic	Author, Documentation Architect, Template Author
HTML Title as Link Text	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.	topic	Documentation Architect, Documentation Gardener
Impersonator - using Live Templates	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.	topic	Author, Template Author, Documentation Architect
Import Properties for Transclusion	Shows how to import properties from another document to be applied to placeholders in transclusions.	topic	Author, Template Author, Documentation Architect
Increasing the Document Cache	If you have lots of projectdoc documents then the in-memory properties cache might not perform optimal.	topic	Confluence Administrator, Documentation Architect
Information System Macros	List of macros linking to or transcluding from external information systems.	topic	Author, Documentation Architect
Learning projectdoc	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.	topic	Documentation Architect, Documentation Gardener, Author, Template Author, Sponsor
Linking to Glossary Terms	Show how to use the Name List Macro to render links to glossary terms.	topic	Documentation Architect, Documentation Gardener, Template Author, Author
Living Documentation	Integrate information from different sources into your documentation using Confluence and the projectdoc Toolbox.	topic	Documentation Architect
Modular Content Doctypes	Doctypes that help to write modular documentation and therefore support single sourcing.	topic	Author, Template Author, Documentation Architect
Modularization	Using sections and modules to organize and reference content.	topic	Documentation Architect, Documentation Gardener, Template Author, Author
Monitoring Confluence	Have you ever experienced performance problems with your Confluence on premise (Server) installation? This tip might help you.	topic	Confluence Administrator, Documentation Architect
Navigating Documentations	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.	topic	Documentation Architect, Documentation Gardener, Template Author, Author
projectdoc Doctype Add-ons	Doctype add-ons provide space and page blueprints based on macros from the projectdoc Toolbox.	topic	Documentation Architect
projectdoc System Properties	Lists recognized system properties specified on the command line for starting the Confluence server.	topic	Author, Documentation Architect, Documentation Gardener
Query Configuration	Controls the parameter to use for running queries with the projectdoc Toolbox.	topic	Confluence Administrator, Documentation Architect, Documentation Gardener
Remote Controls for Transclusion	Alter the rendering of macros of transcluded content with remote controls.	topic	Author, Documentation Architect, Documentation Gardener, Template Author
Rendering Navigation Links	There are basically five ways to render navigation links with additional properties with the projectdoc Toolbox.	topic	Author, Template Author, Documentation Architect
REST Login to Confluence with cURL	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.	topic	Author, Documentation Architect, Documentation Gardener
Search Filter based on Properties	Show how to use document properties to filter on searches.	topic	Reader, Documentation Architect
Search Space for Index Spaces	Define the default search space for index spaces.	topic	Author, Documentation Architect, Documentation Gardener
Search Tips	Tips on specifying search queries for Lucene. This also applies to projectdoc's query macros.	topic	Author, Documentation Architect
Section in Action	Use the Section Macro to define sections. This tip introduces the macro by listing its features.	topic	Template Author, Author, Documentation Architect
Selection Boxes on ad-hoc Doctypes	Define a doctype on document instances to select from its set of values.	topic	Author, Documentation Architect, Documentation Gardener
Space Properties	Lists the configuration options at space level.	topic	Author, Documentation Architect, Documentation Gardener
Space Property Controls	Lists valid controls for properties to be used as space properties.	topic	Author, Documentation Architect, Documentation Gardener
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.	topic	Author, Template Author, Documentation Architect
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.	topic	Author, Template Author, Documentation Architect
Supply Documents	Show how to import properties from other projectdoc documents into a projectdoc document.	topic	Documentation Architect, Documentation Gardener, Template Author, Author
Support Browsing	Tools from the projectdoc Toolbox to allow users to browse for information.	topic	Documentation Architect, Documentation Gardener, Template Author, Author
Support Recalling	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!	topic	Author Documentation Architect Template Author
Template Variables	List of variables provided in the blueprint context for templates.	topic	Template Author, Documentation Architect
The Workhorse Macros	Learn about the central most heavily used macros of your projectdoc Toolbox.	topic	Documentation Architect, Author
Think Repositories	To organize your documentation place documents in a typed repository and add additional views on demand.	topic	Author, Documentation Architect, Documentation Gardener
Toggle Views	Shows how to use the Wiki Link Macro based on Remote Controls to alternate between two different views on a single document.	topic	Template Author, Documentation Architect, Author
Transclusion References	Keeping track of transclusions using artificial properties.	topic	Documentation Architect, Template Author, Author
Type-specific Categories	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.	topic	Author, Template Author, Documentation Architect, Documentation Gardener
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.	topic	Documentation Architect, Confluence Administrator, Documentation Gardener
Using Aspects	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.	topic	Documentation Architect, Documentation Gardener, Template Author, Author
Using Spaces	A short introduction on using spaces with the projectdoc Toolbox for Confluence.	topic	Author, Documentation Architect
Variables for Blueprints	The projectdoc Toolbox provides an interface for template authors to replace placeholders with space and context properties.	topic	Template Author, Documentation Architect
Views on Topics	projectdoc makes it easy to create a modular documentation and provide multiple views on topics.	topic	Documentation Architect, Documentation Gardener, Author
Web of Documents	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.	topic	Template Author, Documentation Architect
What's next?	Checkout further resources on working with projectdoc.	topic	Documentation Architect, Author

Documentation Architect

Description

Documentation