-
Notifications
You must be signed in to change notification settings - Fork 520
Add October 2025 newsletter #2450
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+133
−0
Merged
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
6371eaa
Add October 2025 newsletter
CollierCZ 51c315e
Fix style errors
CollierCZ ec9006e
Apply suggestions from review
CollierCZ 00bb3d4
Apply suggestion from @hillaryfraley
CollierCZ 86f4fbf
Apply suggestion
CollierCZ b8a2cbc
Apply suggestion
CollierCZ File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,129 @@ | ||
:og:image: https://www.writethedocs.org/_static/logo-opengraph.png | ||
|
||
.. post:: October 06, 2025 | ||
:tags: newsletter | ||
|
||
######################################## | ||
Write the Docs Newsletter – October 2025 | ||
######################################## | ||
|
||
Hello, documentarians! I hope you are all staying grounded amid a world that seems to be changing fast. Docs still matter and so do you. | ||
|
||
In conference news, Write the Docs Berlin is coming up soon, on October 27-28. If you don't have your in-person ticket yet, `get one soon </conf/berlin/2025/tickets/>`__ before they sell out. Or if you can't be there in person, get a virtual ticket for live access to the talks and interaction with other attendees. | ||
|
||
If you're already looking forward to next year, Write the Docs Portland 2026 has its dates set for May 3–5. See `more info </conf/portland/2026/news/welcome/>`__ and start making plans. | ||
|
||
In other news, the `2025 Salary Survey <https://salary-survey.writethedocs.org/>`__ is now open for submissions. We encourage contributions from everyone who has worked in a documentation-related role for at least part of the past year -- full-time, part-time, employee, contractor, or any combination thereof. Returning contributors will be pleased to hear that it's now shorter! | ||
|
||
This month's newsletter has articles on whether AI mean people don't need to know the product, how to encourage others at your company to search before asking, how to use AI to prove your value, and whether to publish docs late or push to delay releases. Enjoy! | ||
CollierCZ marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
------------------------------------- | ||
AI and the need for product knowledge | ||
------------------------------------- | ||
|
||
As generative AI and AI agents change how users find help, documentarians might be wondering whether users still need traditional product knowledge from documentation to use software effectively. | ||
|
||
AI agents can reduce the need for product knowledge but do not eliminate it. Users tend to see how far they can get before they get stuck, but they typically do eventually need the docs. Users also still need a baseline understanding of the product and its capabilities. LLMs themselves rely on documentation to provide accurate information. Documentation therefore remains the trusted source of truth for users as well as AI assistants that are trained on product content. | ||
CollierCZ marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
The extent of product knowledge that users need also varies. Basic apps require less knowledge, whereas open-ended or domain‑specific software requires both product and subject‑matter knowledge, with good docs as the mortar between the two. AI can help with discovery and less complex step‑by‑step tasks, but it struggles with consistency, novel cases, and new features. So reliable, up‑to‑date documentation is again crucial for both users and LLMs. | ||
|
||
Development moves quickly. LLMs that can interpret codebases and summarize product capabilities and new features may become available. However, accuracy is likely to remain a concern and such LLMs would still need to be primed with good documentation. | ||
|
||
See more Write the Docs resources about `AI and LLMs </topics/#ai-and-llms>`__. | ||
|
||
-------------------------------------------- | ||
Encouraging colleagues to search for content | ||
-------------------------------------------- | ||
|
||
If you (or your team) are responsible for creating content for internal audiences, how do you get fellow employees to read the documentation? A recent conversation brought up frustrations about this problem. First, consider asking whether employees have problems finding the content they need. This could be valuable feedback about the existing documentation – for example, ease of use or missing content. | ||
|
||
In general, it’s unsatisfactory to always answer questions when documentation is available. Others may prefer direct answers to their questions, but it reinforces bad habits and can overwhelm your team and impede your team’s work. | ||
CollierCZ marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
You could try training coworkers about the available documentation. Presentations such as “Lunch & Learns” and “Walkthroughs” may help. But your colleagues may find them boring, ignore the available resources, and keep asking your team. | ||
|
||
If the problem occurs within internal communication platforms (such as Slack workspaces), there may be an AI integration tool (such as `Moveworks <https://www.moveworks.com/>`__ or `RAG AI chatbots <https://www.anaconda.com/blog/how-to-build-a-retrieval-augmented-generation-chatbot>`__) to answer questions based upon existing documentation. Such a tool may be costly to implement though, so you'd need a budget and approval. Also, depending upon implementation, employees may be challenged by new technology. | ||
|
||
Games can be a fun way for your coworkers to learn about available resources. You can be creative about the types of games (such as bingo, quizzes), the reward system, using intra-or inter-departmental competitions, and whether to publicly recognize the winners. Without sufficient rewards or recognition, gamification may not work. Some employees may consider games patronizing or "a waste of time". | ||
|
||
To reinforce a shift from asking to finding their own answers, you could respond to questions with a standard intro (such as, "I used the KB search tool to find the answer:”) and then a link to the relevant content. This encourages use of available resources. Additionally, have managers and mentors direct their employees to use the documentation. | ||
|
||
See more Write the Docs resources about `working with other roles </topics/#working-with-other-roles>`__. | ||
|
||
------------------------------------------ | ||
Using AI to prove AI shouldn’t replace you | ||
------------------------------------------ | ||
|
||
Many organizations are adopting AI tools to help users find information faster. As these tools become more common in documentation workflows, some leadership teams are beginning to question whether human writers are still needed. In some cases, they have even explored using AI to automate routine updates or replace documentarians altogether. | ||
|
||
Ironically, AI can help prove why documentation teams are essential. AI-powered search tools, such as Kapa, can estimate the return on investment (ROI) of documentation through metrics such as support hours saved and customer frustration avoided. These numbers turn the usually invisible impact of documentation into something concrete that leadership can understand. When tracked and shared regularly, they can influence critical business decisions – such as which roles to keep during layoffs or where to invest resources. | ||
|
||
It’s also important to remember that AI depends on high-quality, current content. If documentation is outdated or incomplete, AI will surface wrong answers, frustrate users, and damage trust. AI can scale access to good content, but it cannot maintain or verify that content on its own. | ||
CollierCZ marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
To make documentation’s value even clearer, some teams pair AI-generated ROI data with additional metrics: page views, contributor activity, support ticket deflection, and short narratives of real wins. Together, the data paints a fuller picture of how documentation supports both users and the business. | ||
|
||
The takeaway: AI can enhance documentation, but it can’t replace the human expertise that makes documentation effective. | ||
|
||
See more Write the Docs resources about `AI and LLMs </topics/#ai-and-llms>`__. | ||
|
||
----------------------------------- | ||
Delay releases or publish docs late | ||
----------------------------------- | ||
|
||
A recent question in the `#jira channel <https://writethedocs.slack.com/archives/C42DVF7U7>`__ asked whether people delayed software releases until docs are ready or rather released docs after releases, maybe weeks later. Some expected the process would look different at small companies versus more established, large ones. | ||
|
||
Some responses noted they aim to get release notes published before any release to prepare users for change. Although not always successful, the idea is to prepare people for changes that might affect established ways of working. | ||
|
||
One respondent reported success with getting docs to have their own column in a Jira board, which forced people to recognize the work of everyone on the cross-functional team. They even had their column come before QA work, meaning the docs were ready for publishing by the time QA signed off on the feature for release. | ||
|
||
Take care that increased visibility within the process can mean an increased need for sign-off from others, such as developers or client-facing team members. This can lead to delays in the docs being ready to publish. | ||
|
||
Another person noted the importance of getting commitment in advance. Ask Product Managers whether the feature is one that they'd delay for docs before development starts – make docs a part of the definition of done and the feature won't be done until the docs are. | ||
|
||
See more Write the Docs resources about `Agile and workflows </topics/#agile-and-workflows>`__. | ||
|
||
---------------- | ||
From our sponsor | ||
---------------- | ||
|
||
This month’s newsletter is sponsored by `Depot <https://bit.ly/4nVpVXV>`_. | ||
|
||
.. image:: /_static/img/sponsors/depot.png | ||
:align: center | ||
:width: 50% | ||
:target: https://bit.ly/4nVpVXV | ||
:alt: Depot logo | ||
|
||
**Depot just published a guide on collaborating with Claude to write better technical documentation.** Discover how AI-assisted workflows excel at the hardest documentation challenges: complex features spanning multiple files, cross-repository docs that need to stay in sync with code, and that all-too-common scenario where features ship first and docs come later. If you're tired of documentation debt, this approach might change how you work. | ||
|
||
**At Depot, we're always experimenting with better ways to build and document software.** See the practical strategies we use to maintain consistency, catch issues early, and keep our docs actually useful. `Read our guide on collaborating with Claude on docs. <https://bit.ly/4nVpVXV>`__ | ||
|
||
*Interested in sponsoring the newsletter? Take a look at our* `sponsorship prospectus </sponsorship/newsletter/>`__. | ||
|
||
------------------ | ||
Featured job posts | ||
------------------ | ||
|
||
`Technical Content Writer <https://au.indeed.com/job/technical-content-writer-41cb56b3d9bb3007>`__, StoreConnect - *Australia/Remote* | ||
|
||
*Interested in promoting your open position? See our* `job posting sponsorship </sponsorship/jobs/>`__ *for more details.* | ||
|
||
------------------------ | ||
Write the Docs resources | ||
------------------------ | ||
|
||
Write the Docs offers lots of valuable resources related to documentation. See all of the Write the Docs `learning resources </about/learning-resources/>`__. To discuss any of these ideas or others related to documentation, join the conversation in the `Write the Docs Slack community </slack/>`__ in one of the many `channels </slack/#channel-guide>`__. | ||
|
||
---------------- | ||
Events coming up | ||
---------------- | ||
|
||
- 17 Oct, 08:30 EDT (US East Coast Virtual): `Write the Docs East Coast Virtual Meetup <https://www.meetup.com/write-the-docs-east-coast/events/307540184/>`__ | ||
- 18 Oct, 10:00 MDT (Boulder/Denver, USA): `October Coffee & Conversation <https://www.meetup.com/write-the-docs-boulder-denver/events/310963840/>`__ | ||
- 19 Oct, 13:00 EDT (North Carolina, USA): `Write the Docs NC Social Hike @ Bass Lake <https://www.meetup.com/write-the-docs-north-carolina/events/310229967/>`__ | ||
- 20 Oct, 12:30 IDT (Tel Aviv+, Israel): `Onboarding Yourself as a Technical Writer: Hitting the Ground Running <https://www.meetup.com/write-the-docs-taplus/events/311066836/>`__ | ||
- 23 Oct, 18:30 BST (London, United Kingdom): `Prose and Cons: Creative Writing for Technical Docs <https://www.meetup.com/write-the-docs-london/events/311099089/>`__ | ||
- 23 Oct, 17:30 PDT (Portland, USA): `WTD PDX + PSU Supermeetup: GenAI as Writing Coach w/Dr. Brett Oppegaard <https://www.meetup.com/write-the-docs-pdx/events/311380500/>`__ | ||
- 23 Oct, 18:30 PDT (San Francisco, USA): `How Do Today's Technical Writers Get Things Done? <https://www.meetup.com/write-the-docs-bay-area/events/311029841/>`__ | ||
- 31 Oct, 08:30 EDT (US East Coast Virtual): `Write the Docs East Coast Virtual Meetup <https://www.meetup.com/write-the-docs-east-coast/events/308480857/>`__ | ||
- 4 Nov, 19:00 MST (Calgary, Canada): `Write the Docs Calgary November 2025 Meetup <https://www.meetup.com/wtd-calgary/events/304868585/>`__ | ||
- 5 Nov, 17:30 EST (Pittsburgh, USA): `Doc troubles and social event <https://www.meetup.com/write-the-docs-pittsburgh/events/311359182/>`__ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.