#1275 Issue closed: Relax-and-Recover (ReaR) Documentation Style

Labels: documentation, discuss / RFC, no-issue-activity

gdha opened issue at 2017-03-30 16:05:

Relax-and-Recover (ReaR) Documentation Style

I found the following interesting link: https://toolchain.gitbook.com/
which we could use for writing documentation like our developers guide
https://github.com/rear/rear/wiki/Developers-Guide
Perhaps, I will use it for writing a workshop.
Feedback is welcome...

jsmeix commented at 2017-03-31 07:06:

Ony FYI:
Today I will watch a (SUSE internal) presentation/tutorial
that is about "Technical Writing":

You need to write (technical) texts now and then?
But you are not sure how to structure them,
how to phrase your content, or how to best address your readers?
This session shows you how to optimize texts to make them
easier to understand. Get to know universal principles that
can be applied to a wide variety of text types - including
release notes, bug reports, error messages, or e-mails. 

github-actions commented at 2020-07-02 01:33:

Stale issue message


[Export of Github issue for rear/rear.]