Contributing to Tasks in Documentation

[sasakisasaki]

Hello! I want to contribute for improvement in the documentation such as translation, ... etc. As the first try, I created this file based on this Japanese version.
→ I'm sorry, the file I added already exists 🙇

Is there the best practice for doing this kind of tasks or something similar? Any feedback and comments are highly appreciated. Thank you very much in advance!

[takayuki5168]

@sasakisasaki
Hi! Thank you for the suggestion and contribution!

Actually, the surround obstacle checker has an English version's document, which is a README.md.
https://github.com/autowarefoundation/autoware.universe/blob/main/planning/surround_obstacle_checker/README.md

Like the above, most packages have an English version's document, so we do not have tasks to translate the documentation for now.
Give me some time to think about the documentation tasks.

[sasakisasaki]

@takayuki5168 Thank you so much for your kind message. I'm really sorry that I did not check if the translated one already exists and made the confusion.

Give me some time to think about the documentation tasks.

Thank you Takayuki san! I'll be re-learning the Autoware repositories not to make the same mistakes!

[takayuki5168]

I couldn't come up with so many tasks, but the following is the candidate.

• Tasks without a deep understanding of Autoware's modules (e.g. translation)
  • Task: Unifying the format of figures of use cases
    • The format of figures of use cases in the documentation is not unified for now.
    • For example, we are recently using the format of the figures as shown in the following document. (This is not an official format though.)
      • https://autowarefoundation.github.io/autoware.universe/main/planning/behavior_velocity_crosswalk_module/
      • 
    • However, there is a lot of documentation whose figures' format is different from the above as follows for example.
      • https://autowarefoundation.github.io/autoware.universe/main/planning/behavior_velocity_occlusion_spot_module/
    • Towards the unified documentation, we want to change the format of the figures in the above of documentation. We often use draw.io to create SVG figures.
• Tasks with an understanding of Autoware's modules
  • Task: Write a missing explanation
    • Some of the documents do not have enough information to understand the feature, or the explanation is not straightforward and hard to understand.
    • Therefore, we should refine some of the document so that the users can understand Autoware's modules easily.
    • In order to refine the explanation, understanding the module's role, behavior, etc is necessary by reading the code or asking questions to the code owners.