Skip to content

Instantly share code, notes, and snippets.

@graphitefriction

graphitefriction/asciidoctor-docs-ia.adoc

Last active August 31, 2015 05:54
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save graphitefriction/6adff94aa85087e7890c to your computer and use it in GitHub Desktop.
Save graphitefriction/6adff94aa85087e7890c to your computer and use it in GitHub Desktop.
Download ZIP
Brainstorming for Asciidoctor Docs IA upgrade. Please comment.
Raw
asciidoctor-docs-ia.adoc

Asciidoctor Docs Information Architecture

This gist is connected to this issue: 366

  1. Make a list of all of the parts of the Asciidoctor toolchain.

  2. Make a list of the different types/stages of Asciidoctor users.

What parts of the toolchain are missing?

Just a few types of users have been added. We need to flesh out the groups and add (or cut).

Asciidoctor Toolchain

  • Core

    • Syntax

    • Parser

    • AST

  • Viewing Tools

    • Docgist

    • Firefox Plugin

    • Chrome Plugin

    • Guard with Live Reload

  • Editing Tools

    • Brackets

    • Atom

  • Converters

    • HTML

    • PDF

    • EPUB

    • DocBook

    • Latex

    • Reveal

    • DZSlides

    • XHTML

    • Manpages

    • fopub (archived)

    • Stylesheets

      • Custom styles per converter

  • Diagrams and Equations

    • PlantUML

    • Ditaa

    • Shaape

    • BlockDiag, SeqDiag, ActDiag, NwDiag

    • GraphViz DOT

  • Asciidoclet

  • Plugins

    • Gradle

    • Maven

    • Gulp

    • Grunt

    • Leiningen

    • Ant

    • sbt

    • Intellij

    • Eclipse (in progress)

  • Implementations

    • Ruby (Core)

    • Java

    • JavaScript

    • GroovyDSL

  • Web Publishing

    • Confluence

    • Jekyll

    • Editions

  • Docker Container

    • Asciidoctor

    • AsciidoctorJ

  • Extensions Lab

  • Distributions

    • RubyGems

    • Debian

    • Fedora

  • Organization infrastructure

    • Doctest Suite

    • html-pipeline (infrastructure for GitHub)

    • RPM package spec

    • webjars

    • Yard

    • Rdoc

    • Javadoc

Asciidoctor Users

Group 1 (Also applies to new users)

  1. Common Syntax

  2. No Install

  3. Local or Browser Editing

  4. Browser Viewing

    1. HTML Converter

Group 2 (also applies to new users)

  1. Common Syntax

  2. Install

    1. Windows

    2. Mac OS

    3. Linux

      1. Package

  3. Local or Browser Editing

  4. Local or Browser Viewing

  5. Converter

Group 3

  1. Web publishing

    1. Group 1 or 2 Install and Usage

  2. Push to web publishing platform

    1. Confluence

    2. Jekyll

    3. etc…​

Group 4

  1. Build Docs with <build-tool-name>

Group 5

  1. Convert to <name-of-alternative-converter>

Group 6

  1. Customize stylesheet for <name-of-alternative-converter>

Group 7

  1. Use the AST

Group 8

  1. Write a book with Asciidoctor (advanced syntax)

Group 9

  1. Add diagrams and equations to content (advanced syntax)

Group 10

  1. Developers writing with Asciidoctor (advanced syntax (source code highlight, UI macros))

Group 11

  1. Integrate Asciidoctor into your <continuous-integration/delivery-pipeline>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment