this post was submitted on 11 Dec 2023
65 points (98.5% liked)

Technology

59374 readers
3250 users here now

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


Our Rules


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

Approved Bots


founded 1 year ago
MODERATORS
top 3 comments
sorted by: hot top controversial new old
[–] [email protected] 14 points 11 months ago (1 children)

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!

[–] [email protected] 4 points 11 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.

[–] [email protected] 4 points 11 months ago

I wish Apple followed these rules. So many deprecations in their man pages and developer documentation have no details at all. No idea what the supposed replacement is. No idea of the underlying reasons. No idea when it will cease to function.

This is why I still see "launchctl load" everywhere. It's been deprecated for years, but the replacements are overcomplicated and not clearly communicated in official docs. When Apple finally pulls the plug, so much shit out there is going to break.

When they deprecated python2, they withheld implementation details and any timeline. Then they finally axed it in a freaking minor point release, without even replacing it with python3. AAAAAAH