• Working Draft
  • Understanding DCB Documentation

    This page captures conventions for documentation within the DCB Confluence space.

    Understanding page status

    Use page status to indicate how reliable or volatile page content is.

    Hover over the page title to show the Set Page Status menu
    Change or remove an existing status from the dropdown in the top right of page

    Use status (along with info and warning panels as needed) to indicate

    Status

    What it means

    Status

    What it means

    Stub

    The page is a placeholder. It may contain a brief outline and/or a short 1-2 sentence summary about what the scope and purpose will be.

    Subject to change

    The page has fluid content which could get turned over if new info or feedback comes to light. It should be considered an early or rough draft, where document content and organisation are volatile. To this end, it is unlikely to be ready for general review or comment.

    Working Draft

    The page content can be considered reliable for working against. There may be adjustments following a formal or informal review, but it is broadly complete and accurate.

    Any known gaps, unknowns or gotchas should be explicitly called out with info or warning panels.

    Current and Stable

    The page is considered definitive and authoritative, as far as these things can be. It is complete for its intended scope, and it contains accurate content that is still relevant.

    Archive or Obsolete

    The page is no longer considered current or maintained. It may be superceded or no longer relevant. Readers should not rely on this content for, but it may provide historical interest. Obsolete pages should use an info or warning panel link to replacement sources.

     

     

    Operated as a Community Resource by the Open Library Foundation