diff --git a/documentation-guidelines.md b/documentation-guidelines.md index 7619129..07d26c0 100644 --- a/documentation-guidelines.md +++ b/documentation-guidelines.md @@ -6,6 +6,22 @@ Best practices and guidelines for writing code documentation. All documentation should be easy maintain and accessible. Easy formats should be preffered over more complex ones. +### Markdown + +Markdown is the easiest format to write and read. It is recommended to use markdown for all documentation as long as more complex formatting is not needed. + +### AsciiDoc + +AsciiDoc allows more formatting and can create more official looking documents. + +It is recommended to write a pipeline template to easily convert AsciiDoc files to PDFs. Thre we can also have an AsciiDoc template specifiying the look of the PDF. The pipeline template then makes it easy to consume the pdf creation functionality. + +To manually create a PDF from an AsciiDoc file, you need asciidoctor and use the following command: + +```bash +asciidoctor-pdf -a pdf-theme=my-theme.yml example.adoc +``` + ## PlantUML Create png images from PlantUML files using the following command: