Generating PowerShell module documentation with platyPS http://dlvr.it/TJmWFP via PlanetPowerShell #PowerShell #platyPS #Documentation #TechWriting
#techwriting
0 posts0 participants0 posts today
Been experimenting with a new writing format for technical documentation lately, blending narrative storytelling with traditional instruction manuals.
It's fascinating how much more engaging complex info becomes when you add a human element.
Anyone else playing with unique writing formats?
Got insights on the past, present, or future of the Internet? Share your story on RIPE Labs for a chance to win a trip to RIPE 90 this May in Lisbon!
Deadline: Friday, 4 April
Time: 23:00 CET
Submit online via RIPE Labs
More info & submit your entry: https://labs.ripe.net/competitions/ripe-labs-article-competition-ripe-90/
All articles go through the usual RIPE Labs review process—just tick the competition entry box when submitting.
Looking forward to reading your stories!
Do developers need code samples in API documentation?
https://idratherbewriting.com/blog/code-samples-might-not-be-needed-anymore
I’d Rather Be Writing Blog and API doc course · Do developers need code samples in API documentation?Although code samples have long been a staple in API documentation, I’m not sure users need them that much. Many developers now use AI tools that can generate the same basic code samples that are commonly provided in documentation. If these same developers pass in either the source files or reference documentation, AI tools can generate the code samples they need in the language they want, and better yet, tailored to their project and business context.
Improve your documentation with beautiful code examples! CodeXnapper makes it easy to create visually appealing code snippets for your docs. https://CodeXnapper.com #Documentation #CodeXnapper #TechWriting
CodeXnapperCodeXnapperThe ultimate macOS app that takes the hassle out of capturing and refining your code snippets. Keep your focus exactly where it belongs—on writing great code.
Who has any 2025 job hunt advice?
- 3.5 years in #ux (mostly research)
- 7.5 years in digital #libraries
- 3 years in #techwriting
- About a year of #advertising media & #marketing
I'm deeply passionate about finding ways to connect people with valuable information, but also quite flexible on the approach. I have plenty of time for virtual coffee if anyone wants to connect. 
Or shoot me your tips below if you have a minute!
If you're programming/coding I'd love your help here:
What are some of the best examples you've seen (that are public/I can view - any language is fine) of programming tutorials and/or example code?
I'm looking for the best examples that illustrate how a a program is put together, the patterns it's using, so that you do the same yourself.
Continued thread
And the next on my reading recommendation about #techwriting is "Every page is page one" from Mark Baker. It helps to rethink the structure of content away from the classical book to a collection of linked pages.
Continued thread
I'd like to continue this thread about reading recommendation about technical writing.
The next book I can recommend is "The Product is Docs: Writing technical documentation in a product development group" Christopher Gales and the Splunk Documentation Team. It "provides a perspective about the essential aspects of creating technical documentation in today's product development world".
During #UniventionSummit I was asked several times about reading recommendations for #techwriting . A good start is https://www.writethedocs.org/guide/. To dive deeper into the topic, I recommend reading the book "The Insider's Guide to Technical Writing" from Krista Van Laan. Yes, a book 
.
Write the DocsSoftware documentation guideThis guide gathers the collective wisdom of the Write the Docs community around best practices for creating software documentation and technical writing. The guide originally started for developers...
What a wonderful day an #UniventionSummit . I enjoyed meeting long term colleagues from other companies, getting to know inspiring new people, and exchanging experiences about #techwriting . I'm looking forward to the recordings of the talks, especially of "Digitale Enteignung - Wie Big Tech Wirtschaft und Demokratie zerstört" from Martin Andree.
In 2025 I wish this for you all:
May you be concise, not just thorough.
May you be confident, not just hopeful.
May you be correct, not just complete.
What do people think of LeanPub?
Left here for fellow programmers who will inevitably need this hug.
Spoke at the #WriteTheDocs meetup in Berlin yesterday, and it was an absolute pleasure connecting with so many like-minded folks! 
We dove into emerging trends in the documentation world and how to stay ahead of the curve in the near future. 
#TechWriting #Documentation #Writerside
I’ve published a technical article on static #Linux binary builds over on my blog months ago. But this article has been featured in issue #5 of @PagedOut
(https://pagedout.institute), a free, community-driven magazine for tech enthusiasts!
Paged Out!Paged Out!Deeply technical zine. And it's free.
As part of my quest to make #GNOME i18n rock, I did some #TechWriting and improved the Damned Lies OpenAPI documentation.
Can you find the 7 differences?
Calling those who write #documentation or work in a closely adjacent role!
The Write the Docs salary survey is live and available. This is for anyone who has been paid for documentation or documentation-adjacent work in the past year, regardless of current work status, employee/contractor classification, location, and so on.
Documentation Salary Survey 2024WTD Documentation Salary Survey 2024 - open for submissions!Our salary survey is now open for submissions! Help us create a benchmark for appropriate salary ranges for documentation roles world-wide.
Speaker Spotlight: Jess Li
Ready to level up your tech writing? 
Meet Jess Li, a software engineer with 10 years of experience at companies like Facebook, Pinterest, and Stripe.
In her SquiggleConf talk "How to Write About Software," Jess will share insider tips on making technical writing fun, clear, and relatable.
Get ready for some actionable insights that will transform your writing game. Don’t miss out!
