mstdn.social is one of the many independent Mastodon servers you can use to participate in the fediverse.
A general-purpose Mastodon server with a 500 character limit. All languages are welcome.

Administered by:

Server stats:

9.6K
active users

#Documentation

18 posts17 participants0 posts today

Do you already know our YouTube channel? 📹 If not, then it's high time you took a look, watched our videos and subscribed to the channel so you don't miss anything anymore. ✅ No matter what interests you about our products, services, employees, company other other stuff – you can find it here youtube.com/@NineInternetSolut on our YouTube channel. 👈 #youtube #videos #channel #subscribe #news #documentation #help #support #nine

"While haste and speed often get confused, they differ in that the second shows control instead of panic. You can maximize speed while keeping accuracy quite high; beyond a certain point, though, spending more time on accuracy, style, or other aspects that prevent a document from going live always yields diminishing returns.

Nobody reads perfect yet outdated docs, except historians. Even then, docs aren’t perfect, because documentation can’t ever be perfect. This is a key principle I stand by (call it the Ferri Paradox if you want): Any document describing a system is necessarily inaccurate. And yet, this reality doesn’t significantly alter the impact of our work, because we aim for simplicity and usefulness over extreme faithfulness. Given how imperfect products are, docs are a charitable portrait.

Now, how you write docs quickly depends on a number of factors. Some of those factors you can’t control: your overall amount of experience as a writer, your initial expertise with specific technologies, and the way features are developed and released in your organization. But other aspects are yours to act upon. For example, you can decide how to best use the technical resources at your disposal and how to approach writing the docs and asking for feedback."

passo.uno/how-write-tech-docs-

passo.uno · How I write docs quicklyI’ve been writing documentation and technical articles for more than a decade now. One piece of feedback I consistently got from managers and peers during all these years is how fast I am when producing and releasing docs. For example, I was once asked to document a new feature from a team I wasn’t serving two weeks ahead of launch. Everything was new to me, but I had most of the docs drafted after four days. By launch, the docs had been deemed ready to go live.

Basic Questions That Every (Technical) Writer Should Try To Answer - AKA Technical Writing 101:

I assure you that If you can answer all of these questions, your readers won't mistake you for a chatbot :)

1. What is the purpose of the document that I'm writing?

2. Why am I writing this document?

3. Who is the target audience of this document?

4. Is this document part of a series of documents?

5. If so, have I established a nexus to the other documents in the series?

6. Are there any predefined formal requirements that the document must meet?

7. Does the document meet those requirements?

8. Does the document include an introduction?

9. Does the introduction clearly explain the purpose of the document to the target audience?

10. Does the introduction present the topics that will be explored in the body of the document in a straightforward way?

11. Does the document include a conclusion?

12. Does the conclusion provide a good summary of the previously explored topics?

13. Does the conclusion tell readers what they should have learned by following the document?

14. Does the body of the document include use case scenarios based on user personas that explain the potential advantages of adopting the explored tools or methods?

15. Does the body of the document depict real-life examples of how readers can immediately start using the tools or methods explained in the document?

Some people before 2022:

Person A: "Nah, who needs documentation!? It's too much effort and not very useful."

Person B: "But how should I understand this project then!? I'm totally lost right now!"

Some people after 2022:

Person X: "PR is ready for review. Please also have a look at the automated tests."

Person A: "This needs rework: Please also update our cursor-rules, requirements.md and prompt.md file. Otherwise our #LLM will be totally lost!"

We’re celebrating Foreman’s Birthday today, organized by Netways! 🥳

Right now, Maximilian and Aneta are taking the stage with an exciting presentation:
"Foreman Documentation: Year in Review & We Want Your Input!" 📝💬

They’re diving into what’s been improved over the past year and how you can help shape the future of our docs. 🚀

‘He told us to just tell the truth’ – behind a revealing Billy Joel documentary

In HBO’s five-hour portrait, the chart-dominating singer-songwriter gives unusual insight into his career with support from his A-list friends and collaborators

theguardian.com/music/2025/jul

The Guardian · ‘He told us to just tell the truth’ – behind a revealing Billy Joel documentaryBy Jesse Hassenger
Continued thread

And yes, whoever uses #discord for #documentation and #versioning instead of a goddam #git [doesn't have to be @github / #GitHub or @gitlab / #GitLab or @Codeberg / #Codeberg or even @gitea / #Gitea - just use any git and write down your documentation in a useable format like #Markdown or goddamn ASCII plain text FFS] should be banned for life from #coding, working in #IT or contribute to #FLOSS.

  • Because it's literally worse than people shitting "#Ai" #Slop all over the place cuz that can be fixed faster and easier by backrolling said commits and banning the offender!

youtube.com/watch?v=9ehLMlVTRJ

Every CMS user hits a wall — unless there's great documentation to guide the way. Joomla's documentation is written by volunteers and for the community. Whether you're documenting how to build great sites or correcting typos, every edit improves the experience. Want to make Joomla better without touching code? This is your moment.
Find out how you can help to get better Joomla user documentation! magazine.joomla.org/all-issues #Joomla #CMS #OpenSource #Documentation