TW Work Description¶

Tip

TW = Technical Writer, i.e., Documentation Engineer, Content Expert, Content Marketing Expert, etc.

We currently have 2 websites:

GitHub hosts 3 repositories related to Technical Writer:

Product Documentation Work¶

Chinese:

All operation steps, screenshots, parameter descriptions, videos must be consistent with the actual product. TW needs to verify these contents to ensure documentation is always in sync with the product
Download Center and Installation Steps are entry points, these contents should be prioritized for accuracy
Ensure all links in the documentation site are correct. You can run mkdocs serve command in zh/docs or en/docs directory to check links
Update at least 2 blogs per month
DaoCloud Open Source Ecosystem should be consistent with community projects. For example, if Kubean joins Sandbox, related pages should also be updated
Cloud Native Institute collects community news like KubeCon, some beginner tutorials, common Git commands and regular expressions
OpenAPI Documentation: After each monthly release, remember to merge PRs of related modules, then regularly update nav and index pages
d.run Documentation should also be consistent with the UI. This is a new project with fast development iterations, documentation should keep up
Product whitepapers, software copyright, SOP process documentation, and documentation support for presales and delivery colleagues