Technical Writing: Deprecating Content (jamesg.blog)

submitted 10 months ago by alex@jlai.lu to c/technology@lemmy.world

3 comments fedilink hide all child comments

you are viewing a single comment's thread
view the rest of the comments

[-] ryan@the.coolest.zone 14 points 10 months ago

Re: this section:

As a technical writer, you should stay close to the teams whose work you are documenting. Listen out for any code, SDK, or product changes that may require action. When you hear that a tool may be deprecated, start communicating.

It just assumes that nobody will ever proactively reach out to the technical writer about deprecations, which is entirely true in practice, but just feels so sad to acknowledge. Please keep your content and document management team(s) in the loop!

[-] Semi-Hemi-Demigod@kbin.social 4 points 10 months ago

I think engineers and UX should write the documentation first and then start working on the project. That way you have a clear idea of what should be in the software and how it should look. When things change you update the documentation. Then it's already done and complete when you release.

this post was submitted on 11 Dec 2023

65 points (98.5% liked)

Technology

58698 readers

4106 users here now

This is a most excellent place for technology news and articles.

Our Rules

Follow the lemmy.world rules.
Only tech related content.
Be excellent to each another!
Mod approved content bots can post up to 10 articles per day.
Threads asking for personal tech support may be deleted.
Politics threads may be removed.
No memes allowed as posts, OK to post as comments.
Only approved bots from the list below, to ask if your bot can be added please contact us.
Check for duplicates before posting, duplicates may be removed

Approved Bots

founded 1 year ago

MODERATORS