Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Relax-and-Recover (ReaR) Documentation Style #1275

Closed
gdha opened this issue Mar 30, 2017 · 2 comments
Closed

Relax-and-Recover (ReaR) Documentation Style #1275

gdha opened this issue Mar 30, 2017 · 2 comments

Comments

@gdha
Copy link
Member

gdha commented Mar 30, 2017

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
Copy link
Member

jsmeix commented Mar 31, 2017

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. 

@jsmeix jsmeix removed their assignment Jul 19, 2017
@github-actions
Copy link

github-actions bot commented Jul 2, 2020

Stale issue message

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants