• ryan@the.coolest.zone
    link
    fedilink
    arrow-up
    14
    ·
    11 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
      link
      fedilink
      arrow-up
      4
      ·
      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.