As reflected in the two separate guides this repository generates, there are two fairly distinct user-persona categories expected to engage with the documented LiquiDoc/LDCMF instance.

The Roles

Anyone producing or editing content for this project — whether their title is engineer, technical writer, or documentation manager — is acting in the role of documentarian: a documentation contributor.

Another key role is that of administrator, or admin. This role is responsible for configuration and management of all the technologies underlying the docs build, as well as overseeing adherence to conventions and best practices by documentarians. Anyone fulfilling this role must be comfortable with all of the information in both the Documentarian and Administrator Guides. You are currently reading the Administrator Guide.

The (Administrator) Role

As an administrator of the LiquiDoc/LDCMF User Guides codebase, your responsibilities are many. Because the infrastructure is complex and every documentarian will have opinions, administrators must referee style, formatting, placement, and other conventions.

Administrators are also responsible for maintaining the integrity of the docs build.

Admins are also expected to create and maintain Liquid templates for prebuilding. This necessitates familiarity with AsciiDoc and YAML, the latter of which you will use for many other reasons, as well. You may be able to get away with not really knowing AsciiDoc, as long as documentarians provide you with the proper AsciiDoc format they need from prebuilding operations.

Tags: