Suppose you have a new feature for your software. Features can come from many sources, internal and external to your organization. Internally, they may originate with marketing, sales, support, developers, executives, or even known issues or prior experience. Externally, they can come from users, customers, and even competitors. In fact, competitors are often the catalyst for revolutionary features.
Features can come from anywhere, even from little things you see while you’re biking in the afternoon, or watching the barista in the coffee shop. These many features get collected into roadmaps, which make their way into development plans and specifications, which get assigned to the many developers that make a product successful.
While there are many developers, though, there are few technical authors to translate all this glory into immortal prose — or at least into a decent how-to guide. In fact, large teams of 20 or 30 developers often depend on just one writer to produce all of their documentation. This seems like an unbalanced workload: many features, many developers, one technical author — and yet, it’s a very common practice.
Well, a lot of teams have tried to make this work with a few gimmicks:
These all help — especially the refrigerator, if you love diet soda like I do — but they aren’t sufficient to get the level of productivity needed to produce great documentation. So what else can we do?
“Yeah,” you say, in a sort of sarcastic tone, “crowdsourcing. Don’t expect much when you’re crowdsourcing documentation!” Then you share with me your litany of normal expectation:
Well, let’s be bold. Let’s suppose that “don’t expect much” is almost the right mantra for this plan. What if we modify that to, “don’t expect too much”?
You’d probably say, “Uh, sounds nice, but will it even work in practice?”
I think so. Check out this video to find out how.
In this article, we will see how to install nvidia-smi on Ubuntu or Debian Linux.…
In this article, we will see how to install clang tool on Ubuntu or Debian…
When working with Docker containers on Raspberry Pi devices, you might encounter frustrating signature verification…
You’ve recently upgraded to Ubuntu 18.04 and found that your OpenVPN connection no longer resolves…
Have you ever tried to open System Monitor on your Ubuntu 18.04 system only to…
System hardening means locking down a system and reducing its attack surface: removing unnecessary software…