On Saturday, October 26, 2019 at 11:35:57 PM UTC+2, Matt Wilkie wrote:
>
> Found by way of Guido von Rossum in python discussion forum:
> https://www.divio.com/blog/documentation/
>
> Basically: recognize there are 4 kinds of documentation, serving different 
> functions. Design, write and store them differently. It's in mixing them up 
> in one document/place that leads to mess and confusion on both the author 
> and consumer side. The four are: Tutorials, How-to's, Explanations, and 
> Reference.
>
> I found it to be a good read and intend to see how I can apply it to my 
> work.
>
> -matt
>

Thank you for this link! Great article and video!

I can only recommend to study this article and the video.

One application might be to denote or tag each page of Leo documentation 
with TUT (Tutorial), HOW (How-to- Guide), EXP (Explanation or Discussion), 
and REF (Reference).

It helps to separate, clarify, and delimit what one wants to say/write on a 
particular page.

Reinhard

-- 
You received this message because you are subscribed to the Google Groups 
"leo-editor" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To view this discussion on the web visit 
https://groups.google.com/d/msgid/leo-editor/f3537245-369b-494e-94e2-3df43296b2d1%40googlegroups.com.

Reply via email to