Hello everyone,
We've been working on modular documentation internally (in Red Hat) for a while, and since our efforts and the modularization/modernization initiative Fedora Docs align to a large degree, we want to share with you what we have so far.
The following is a short digest of our progress so far. We still need to decide how to put everything together and how to keep track of various articles, this is mostly thoughts on various types of content. Hopefully you'll find this useful; I'll follow this up later with some additional ideas.
Modular Documentation - Definitions used for RHEL docs
NOTE: This document is not intended as a complete reference guide for documentation-related terminology.
Module = a building block of information with a well-organized structure that can be combined with other modules into a larger assembly; reused piece of content
Procedural module = describes steps to accomplish a task
Conceptual module = explains a concept; i.e. not based on task
Reference module = lists links to related reference information, such as man pages or other documentation, including other modules or assemblies
Assembly = A collection of modules -- a docs realization of a user story
User story = a short description of something the user wants or needs to do to achieve a goal.
Example: As an administrator, I want to set up authentication to a critical system in my infrastructure (gateway VPN, accounting system) to only allow users authenticated via strong authentication methods (two-factor authentication).
As opposed to a use case = a description of interactions between the system and the user or other systems.
*snip*
_______________________________________________ docs mailing list -- docs@xxxxxxxxxxxxxxxxxxxxxxx To unsubscribe send an email to docs-leave@xxxxxxxxxxxxxxxxxxxxxxx
