Add template for rules for Editorial Guide

asam-ev / asam-project-guide

(WIP!) Project Guide for ASAM OpenX standards

Mozilla Public License 2.0

2 stars 0 forks source link

Add template for rules for Editorial Guide #22

Open aydinbas-dokuschmiede opened 2 years ago

aydinbas-dokuschmiede commented 2 years ago

[ ] Add template for rules to https://github.com/asam-ev/asam-project-guide/tree/main/doc/modules/compendium/examples.
[ ] Add process to use template to https://github.com/asam-ev/asam-project-guide/blob/main/doc/modules/compendium/pages/writing_guidelines/documentation_processes.adoc.

aydinbas-dokuschmiede commented 2 years ago

Rough draft:

[#sec-ASM-xx]
=== [Title] (ASM-xx)

*Instructions*

*Exceptions*

There are no exceptions.

*Example*

[#tab-UID]
.caption
[%header]
|===
|No|#Yes#
|[.line-through]#false#|correct
|[.line-through]#false#|correct
|[.line-through]#false#|correct
|===

[.underline]#Code#

...

[.underline]#Result#

...

*Source*