Create accountLogin

Recent searches

No recent searches

Search options

Only available when logged in.
veganism.social is one of the many independent Mastodon servers you can use to participate in the fediverse.
Veganism Social is a welcoming space on the internet for vegans to connect and engage with the broader decentralized social media community.

Administered by:

Server stats:

223
active users

veganism.social: AboutStatusProfiles directoryPrivacy policy

Mastodon: AboutGet the appKeyboard shortcutsView source codev4.4.0-alpha.4

#softwaredocumentation

0 posts0 participants0 posts today
Public *
QUnit

Ever wondered how beforeEach works in unit test frameworks? Check out our new lifecycle diagram!

qunitjs.com/lifecycle/

People generally guess right when it comes to ordering, so why a diagram?

We want to show that the order is guaranteed, and showcase what's possible when you depend on it.

Thanks to FND, Jan, and NullVoxPopuli for improving and promoting this work! H/T @FND @simulo @nullvoxpopuli

Imagine a test with global hooks, and a Parent and Child module that use hooks also. The execution order is: 1. Parent module runs the before hook. 2. Every test in the Parent module inherits context from the before hook, and repeats as follows: call global beforeEach, parent beforeEach, the actual test, parent afterEach, and lastly the global afterEach. 3. The Child module inherits context from the Parent before hook, and then runs its own before hook. 4. Every test in the Child module inherits context from this before hook, and repeats as follows: call global beforeEach, parent beforeEach, child beforeEach, the actual test, child afterEach, parent afterEach, and lastly the global afterEach.
#qunit#WriteTheDocs#TechnicalWriting
Public
Miguel Afonso Caetano

"Most guides to docs like code, even the ones for non-devs, assume you have some developer knowledge: maybe you're already using version control, or you've encountered build pipelines before, or you're working alongside developers.

This guide is for the people who read that paragraph and wished it came with a glossary. This is docs like code for people who don't know what git is and have never installed VS Code.

This post explains terminology and concepts, to help you get a mental model of what's going on. If you prefer to dive in and pick up concepts as you go, skip straight to the tips in How to learn, and come back to the conceptual info as needed."

deborahwrites.com/blog/docs-li

deborahwrites.comDocs like code in very basic terms - Deborah WritesThis is docs like code for people who don't know what git is and have never installed VS Code.
#TechnicalWriting#SoftwareDocumentation#SoftwareDevelopment
Public
Miguel Afonso Caetano

"You can replace tech writers with an LLM, perhaps supervised by engineers, and watch the world burn. Nothing prevents you from doing that. All the temporary gains in efficiency and speed would bring something far worse on their back: the loss of the understanding that turns knowledge into a conversation. Tech writers are interpreters who understand the tech and the humans trying to use it. They’re accountable for their work in ways that machines can’t be.

The future of technical documentation isn’t replacing humans with AI but giving human writers AI-powered tools that augment their capabilities. Let LLMs deal with the tedious work at the margins and keep the humans where they matter most: at the helm of strategy, tending to the architecture, bringing the empathy that turns information into understanding. In the end, docs aren’t just about facts: they’re about trust. And trust is still something only humans can build."

passo.uno/whats-wrong-ai-gener

passo.uno · What's wrong with AI-generated docsIn what is tantamount to a vulgar display of power, social media has been flooded with AI-generated images that mimic the style of Hayao Miyazaki’s anime. Something similar happens daily with tech writing, folks happily throwing context at LLMs and thinking they can vibe write outstanding docs out of them, perhaps even surpassing human writers. Well, it’s time to draw a line. Don’t let AI influencers studioghiblify your work as if it were a matter of processing text.
#AI#GenerativeAI#LLMs
VegansExploreLive feeds
About