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!
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:
Some helpful resources:
Thank you Rahul for your suggestions and resources. Thanks alot.
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).
Thank you Alex for your suggestions. Will definitely look into the course. Thanks alot.