Hey do you know #xml and/or Publican, write in [mostly] proper English, and live in #Linux?

If you do, there's a job waiting for you as a technical editor. Let me know if you apply and I'll officially refer you.

#fedora #rhel #redhat #fedora-docs #docs #documentation

Sooo, what are the prettiest online docs that you know and like? I'm partial to the style of the stripe/slack docs, but I'd like to see what other people like! #documentation

@.@ Just read the Signal changeset for the URL previews:

Wonderful how they ehhh not document their source code. There are exactly 7 comments in the entire changeset of more than 2600 lines of code. ~2000 of them are added.

I'm not sure that's a good sign…

#Signal #codeQuality #infosec #documentation

Bonjour chez vous,

Mais mais je découvre qu'il existe une appli pour avoir des vidéos de ce qu'on fait dans un terminal de manière correct !

#video #terminal #xterm #bash #documentation

🇫🇷 Quelqu'un connaît un éditeur ReST qui permet de visualiser le résultat en temps réel, comme le fait Remarkable pour le markdown?

🇬🇧 Does somebody know a ReST editor which allows you to view the result in real time, like Remarkable does for markdown?

#ReST #Documentation

Author: "[Code] Comments are Evil [..] they can be avoided and instead you can focus on doing a better job of naming things."

Reasonable discussion below the article:

user: "what about THESE type of comments?"
author: "oh yea, those are great and indispensable. but i don't consider those comments to be comments."


I've always considered myself an old school hacker, in the creative sense of the word, separated from the others by the void, and the forces of time.

Here, I'll post infrequently about the following topics:


I may also, from time to time, talk about my attempts to recapture some of the spirit of university mainframes.

Mhm, looks like I discovered an undocumented, unbelievable awesome feature in CodiMD 😳

Looks like we have a completely working reveal renderer for live editing your slide shows implemented. It's just not documented how to turn it on.

See the little difference between the editor mode:

Without type slide:

With type slide:

#CodiMD #CodiMDStories #hiddenFeatures #documentation

Chouette, cette bibliothèque Perl a l'air de me permettre de faire ce que l'on cherche pour un script ! Voyons la doc'…
OK, j'ai rien bitté là…
#perl #rtfm #documentation #wtf #wth

I've never used #ArchLinux, but I've benefited from their wiki times beyond count.

Thanks ArchLinux users! You folks have great #documentation!

I love help new users! But web dev is tough, so I don't come down too hard on the #gohugo docs. The project is always moving forward, and we have a lot of hidden presumptions: git, server hosting, knowing basic web dev.

It's a moving target, but I'm optimistic. Also, #documentation writers are a thing, yo!

What nobody tells you about documentation,

According to the author, there are 4 kind of documentations: Tutorials, How-to Guides, Explanation, Reference. Each one serving a specific purpose.

Interesting read.


Great post about documentation, which is something important and not easy to get it right.

#software #documentation

A propos de documentation, les vidéos de la conf Write The Docs sont publiées : jetez-y un œil, vous en trouverez forcément une pour vous !


Did you know that the #Fedora community has a Fedora classroom project that provides tutorials and Q&A on a regular basis?

Check out the latest recording about Fedora Documentation:

It's about the new setup and how to write your docs including basics of git and adoc.

And for all who dislike Youtube, the video is published under CC so feel free to re-uploaded it on a Peertube instance of your choice! 👍

#FedoraClassroom #linux #documentation #ASCIIDoc #FedoraDocs

"What did you do the past few years?" "Re-factored Fedora docs."

Yes, they really did :)

Read the #FedoraMagazine article about the changes to the fedora docs system and watch out for the upcoming Fedora Classroom session about writing docs.

#docs #documentation #asciidoc #docbook #Fedora #linux

Every day that goes by, I give more and more value to good documentation.

Here is a good summary on how to do it with Python:

#documentation #python #programming