asam-ev / asam-project-guide

(WIP!) Project Guide for ASAM OpenX standards
Mozilla Public License 2.0
2 stars 0 forks source link

Content feedback: Chapter "documentation as code" #82

Open stefancyliax opened 2 years ago

stefancyliax commented 2 years ago

Prerequisites

This is in regards to:

Subject

Documentation As Code

Description

Suggestion

General approach to the chapter: First start with most basic concept --> content is created by simple writing text documents in a certain syntax ("asciidoc") that used to create a rich output format like HTML. Then build upon that ("That allows us to"): collaborative working (branches), repository, version control, review process, branching, automation, separation of content, structure and style. traceability of changes in issues.

URL https://asam-ev.github.io/asam-project-guide/asamprojectguide/concepts/doc-as-code.html
Page Documentation As Code
Module concepts