[RFC 0/1] Documentation standards

* [RFC 0/1] Documentation standards
@ 2021-10-08 18:58 Michael Opdenacker
  2021-10-08 18:58 ` [RFC 1/1] Start of documentation standards document Michael Opdenacker
  0 siblings, 1 reply; 4+ messages in thread
From: Michael Opdenacker @ 2021-10-08 18:58 UTC (permalink / raw)
  To: docs; +Cc: Michael Opdenacker

This is a first attempt to standardize the way documentation
(including diagrams) is created.

I'm proposing to write such rules in MarkDown format, for easier
browsing. This is not included in the generated documentation anyway.

For SVG diagrams, proposing the first version of a template that
should help creating new diagrams by copying and pasting shapes,
boxes, arrows and clipart.

Your feedback is welcome. Standards for writing text, to add symbol
references, for linking, etc., are not written yet. I'd like your
opinion on how the specification draft looks like first, and of
course your ideas to make it better.

Thanks in advance

Michael Opdenacker (1):
  Start of documentation standards document

 README                              |    6 +
 documentation/README                |    9 +-
 documentation/standards.md          |  102 +++
 documentation/template/template.svg | 1160 +++++++++++++++++++++++++++
 4 files changed, 1276 insertions(+), 1 deletion(-)
 create mode 100644 documentation/standards.md
 create mode 100644 documentation/template/template.svg

-- 
2.25.1

^ permalink raw reply	[flat|nested] 4+ messages in thread