1

How to document my work in a way that help other developers?

Profile picture
Associate iOS Developer[L8] at Other18 days ago

Hi everyone,
I am currently working on iOS app localization for a fintech company. The localization setup is already done, and I'm in the middle of the project. I’m planning to write a document to help other developers and my manager easily understand the work I’m doing. Has anyone done something similar before? How did you approach writing documentation for localization projects, and what key points did you include?

Thanks in advance!

32
4

Discussion

(4 comments)
  • 1
    Profile picture
    Tech Lead/Manager at Meta, Pinterest, Kosei
    18 days ago

    I haven't written documentation for a localization project, but from your perspective: what is unique about documentation for this vs a "normal" project?

    One helpful question to ask is about the intended audience:

    • An engineer reading the doc in the computer will want to know how to change the strings in the code and kickoff new jobs for the localization team.
    • A PM will want to know about the progress of localization and any associated data.
    • Also consider the leadership team, eng managers, and localization experts.

    Some helpful resources:

    • 0
      Profile picture
      iOS Developer [OP]
      eSewa
      17 days ago

      Thank you Rahul for your suggestions and resources. Thanks alot.

  • 1
    Profile picture
    Tech Lead @ Robinhood, Meta, Course Hero
    18 days ago

    I recommend checking out this course for an excellent example of a project spec document: System Design Masterclass: Shipping Real Features To Production

    This document will both help you understand how to best lay out and execute the project while helping others understand what you're doing (and provide feedback).

    What I don't recommend is writing some sort of wiki explaining how your code works. Those get outdated super quickly and take a lot of effort to write/maintain, which is why Meta was extremely against that kind of documentation.

    If you are performing well as a software engineer, you should naturally be creating documentation as you go through the workflow (system design doc, detailed pull requests, meeting notes, etc).

    • 1
      Profile picture
      iOS Developer [OP]
      eSewa
      17 days ago

      Thank you Alex for your suggestions. Will definitely look into the course. Thanks alot.