2 minutes to read
Useful Resources
Introduction
Everything you need to know about docToolchain, from the underlying technology to useful resources.
Underlying Technologies
Learn more about the technologies that support docToolchain, as well as some useful resources.
Markup
AsciiDoc
This is our preferred markup language for technical docs.
-
"Asciidoctor Deep Dive Video" by Alexander Schwartz
Markdown
Since we use JBake as a static site generator, you can write your docs in Markdown too.
-
flexmark-java is the Markdown parser and flavor jBake uses.
-
markdown-to-asciidoc library can be used if you prefer to use the
exportMarkdown-Task.
Templates
arc42
The perfect template for your software solution architecture documentation.
Docs as Code
Docs as Code
Treat your docs as if they were code.
Static Site Generator
Static Site Generator
-
The underlying static site generator for the
generateSite-Task is jBake -
Our standard theme is docsy
-
Our CSS framework is Twitter Bootstrap
Books
|
Note
|
These are Amazon affiliate links. |
| Title | Author | Language |
|---|---|---|
Anne Gentle |
English |
|
Modern Technical Writing: An Introduction to Software Documentation |
Andrew Etter |
English |
Gernot Starke, Stefan Zörner, Michael Simons, Ralf D. Müller |
English |
|
Gernot Starke und Peter Hruschka |
English |
|
Simon Brown |
English |
|
arc42 in Aktion: Praktische Tipps zur Architekturdokumentation |
von Gernot Starke and Peter Hruschka40:00 |
German |
von Stefan Zörner |
German |
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.