DocOps

Document Operations (DocOps) is a documentation philosophy based on agile software product development. Simply put, DocOps promotes the ideas, that everyone that develops a product, regardless of role, should document it from their perspective in small fragments using the tools they use. Dynamic documents are assembled from the fragments to meet the needs of a given audience.

We are a group of product developers that have been challenged multiple times to unravel the task of large scale, multi-audience documentation. We are developing a series of tools and services to lower the barriers of DocOps at any scale. Often leveraging other open source projects from other amazing teams and fantastic engineers, we are developing the best documentation experience we can.

Principles

Everyone documents
Compose documents to your audience
Document in the tool you are using
Version and Date everything

Words over no words
Visualizations over words
Adorned visualizations over visualizations

Many small documents over few large documents
Simple documents over complex documents

Automated documents over static documents
Dynamic documents over automated documents

Centralized convention, distributed content

Projects

Version 2022.7 of the extention server enables in IDE previews of DocOps' DSLs and provides a series of editors and code generators to assist in building document visualizations. docops-extension-server Service Steve RoachIan Cooper Rose 09/03/2022Version 2022.7 of the extention server enables in IDE previews of DocOps' DSLs and provides a series of editors and code generators to assist in building document visualizations. A JetBrains, AsciiDoctorJ DocOps Panel Plug-in leverages the DocOps Button Render library to build panels of buttons for the visual navigation of documents. asciidoctorj-docops-panel Plug-in Steve RoachIan Cooper Rose 08/15/2022A JetBrains, AsciiDoctorJ DocOps Panel Plug-in leverages the DocOps Button Render library to build panels of buttons for the visual navigation of documents. DocOps Button Render version 2022.11 is a DSL driven library to declaritively, consistently render SVG "buttons". docops-button-render Library Steve RoachIan Cooper Rose 08/15/2022DocOps Button Render version 2022.11 is a DSL driven library to declaritively, consistently render SVG "buttons". An AssciiDoctorJ IntelliJ plug-in for rendering a GitHub style Architectural Decision Record (ADR). asciidoctorj-docops-adr Plug-in Steve RoachIan Cooper Rose 06/16/2022An AssciiDoctorJ IntelliJ plug-in for rendering a GitHub style Architectural Decision Record (ADR). DocOps Stack is a JetBrains based plug-in for AsciiDoctorJ that leverages the Docops Button Reder Library to build vertical SVG representations of data. asciidoctorj-docops-stack Plug-in Steve RoachIan Cooper Rose 04/20/2022DocOps Stack is a JetBrains based plug-in for AsciiDoctorJ that leverages the Docops Button Reder Library to build vertical SVG representations of data.

Team

Discussions

  • What is DocOps?

  • Documenting APIs

  • Product Documentation

  • Snippets to Documents

  • Finding Documents

  • Using AsciiDocs

  • Using PlantUML