Suggestions
Mike Jang
Linux-focused writer for AI, developers, sysadmins, and security professionals
Mike Jang is a Principal Technical Writer at NGINX, based in the Portland, Oregon Metropolitan Area. He specializes in creating clear and engaging documentation tailored for developers and system administrators. His expertise includes technical writing, content development, and technical documentation management.12
In his role at NGINX, Mike focuses on producing high-quality materials that facilitate understanding and usability of the company's products. His professional background highlights a commitment to effective communication within technical fields.12
Highlights
𝗟𝗮𝘄𝘆𝗲𝗿𝘀 𝘄𝗿𝗶𝘁𝗲 𝘁𝗵𝗲 𝘄𝗮𝘆 𝘁𝗵𝗲𝘆 𝗱𝗼 𝗯𝗲𝗰𝗮𝘂𝘀𝗲:
As described by cognitive scientists, they're practicing witchcraft!
"In English culture, if you want to write something that’s a magic spell, people know that the way to do that is you put a lot of old-fashioned rhymes in there," the cognitive scientist said. "We think maybe center-embedding is signaling legalese in the same way."
#techcomm #fleschKincaid #documentation
𝗧𝗵𝗲 𝗚𝗼𝗼𝗱 𝗗𝗼𝗰𝘀 𝗣𝗿𝗼𝗷𝗲𝗰𝘁 𝗰𝗮𝗻 𝗵𝗲𝗹𝗽 𝘆𝗼𝘂 -- 𝗰𝗿𝗲𝗮𝘁𝗲 𝗯𝗲𝘁𝘁𝗲𝗿 𝗱𝗼𝗰𝘀!
When I saw this slide (see screenshot) at the fossy.us conference a couple of weeks ago, I realized something had changed. A new group had made its mark on the landscape of software documentation. It’s The Good Docs Project (TGDP), at https://lnkd.in/g25EwpCk. It’s an open source community, started in 2019. Their aim is to:
“… educate and empower people to create high-quality documentation by providing them with templates, best practices, and tools to enhance their documentation in open source and beyond.”
The slide was presented by a Ph.D candidate at Northwestern University, Matt Gaughan, https://mgaughan.net/. He described his research based on the 2000+ Git repositories associated with the @Debian project (and their communities).
There are huge communities associated with Debian, Mozilla, and GitHub. It’s a statement to see TGDP at the same level. And they’ve earned it. They:
• Are part of the GitLab open source partners program • Have templates used by major software companies • Use working groups to organize best practices to help others in the industry
Even more, they publicize their “internal” discussions. They share minutes from their working groups. Anyone can review their proposals. I’ve just read their DEI (yes, DEI) proposals which encourages more people to join their leadership. It’s how their leadership avoids burnout.
Other sessions at fossy.us described best practices in community management. Among the technical writing and documentation communities that I know, TGDP is the only one that meets such standards. As I posted on their Slack:
“I look at TGDP, and I’m thinking: templates, community, metrics, governance – no other independent group in the software documentation field has all of these features. One of the themes from fossy.us is the health of OSS communities, and you’ve got it!”
As I understand it, they're even following the standards developed by CHAOSS, (part of the The Linux Foundation,) the standard for measuring health in OSS communities!
Like any healthy community, they’re not afraid of change. They’re talking about moving from Slack to Discord.
While I’ve been watching TGDP for years, I see now what they’ve become. I’m impressed! (Full disclosure: I’ve never been a part of TGDP. I’ve only been a user of their templates. With this post, I’m saying that I’m thankful for what they’ve done.)
#theGoodDocsProject #techcomm #technicalwriting #softwareDocumentation #openSource #OSS #community
