# asciidoc documentation

DevFeed: [asciidoc documentation](<https://devfeed.tech/articles/asciidoc-documentation-27315.md>)

Original publisher: [Read original article](<https://blog.pchudzik.com/201910/asciidoc/>)

Published: 2019-10-24T00:00:00Z

Content type: tutorial

Language: en

Sources: [Paweł Chudzik](<https://devfeed.tech/sources/pawe-chudzik.md>)

Topics: [Documentation](<https://devfeed.tech/topics/documentation.md>), [Development](<https://devfeed.tech/topics/development.md>), [Code](<https://devfeed.tech/topics/code.md>), [Wiki](<https://devfeed.tech/topics/wiki.md>)

Tags: [bitbucket](<https://devfeed.tech/tags/bitbucket.md>), [code](<https://devfeed.tech/tags/code.md>), [development](<https://devfeed.tech/tags/development.md>), [documentation](<https://devfeed.tech/tags/documentation.md>), [github](<https://devfeed.tech/tags/github.md>), [gitlab](<https://devfeed.tech/tags/gitlab.md>), [html](<https://devfeed.tech/tags/html.md>), [markdown](<https://devfeed.tech/tags/markdown.md>), [pdf](<https://devfeed.tech/tags/pdf.md>), [repo](<https://devfeed.tech/tags/repo.md>)

## AI overview

This tutorial explores using Asciidoctor for technical documentation stored alongside source code. It explains how repository-based documentation can be kept current, updated by developers, and reviewed with code, while noting that larger documentation projects may benefit from features such as diagrams, source-code inclusion, and HTML or PDF export.

## Source excerpt

One thing that a lot of people hate to do is writing documentation. Usually, it's postponed until development is finished and once it's done there is rarely time to do it properly. If you get past the struggle of writing it down there is always a problem of keeping it up to date. To avoid those pain points I'm going to explore what we can do with Asciidoctor to simplify this problem. Read more