docs: replace 'Documentor' with 'Technical Writer' terminology

- Renamed README-documentor.md → README-technical-writer.md
- Updated all references from "Documentor" to "Technical Writer" across:
  - README files (README.md, README-developer.md, README-likec4.md)
  - Content pages (documentation section, homepage)
  - LikeC4 models (documentation-platform.c4 in both projects)
- Regenerated LikeC4 webcomponents with updated terminology
- Updated lowercase "documentor" to "technicalWriter" in model IDs

"Technical Writer" is the proper English term for documentation contributors,
replacing the non-standard "Documentor" terminology.
This commit is contained in:
Stephan Lo 2025-11-07 15:57:14 +01:00
parent 9e509ed265
commit df439058a9
13 changed files with 147 additions and 147 deletions

View file

@ -6,11 +6,11 @@ description: >
Learn how to create, maintain, and publish documentation for the developer platform.
---
Welcome to the meta-documentation! This section explains how our documentation platform works and guides you through the documentor role.
Welcome to the meta-documentation! This section explains how our documentation platform works and guides you through the technicalWriter role.
## What is a Documentor?
## What is a Technical Writer?
A **Documentor** is responsible for creating, maintaining, and publishing the developer platform documentation. This includes:
A **Technical Writer** is responsible for creating, maintaining, and publishing the developer platform documentation. This includes:
- Writing and updating content in Markdown
- Creating architecture diagrams with LikeC4

View file

@ -3,7 +3,7 @@ title: "Local Development"
linkTitle: "Local Development"
weight: 20
description: >
Set up your local environment and learn the documentor workflow.
Set up your local environment and learn the technicalWriter workflow.
---
## Prerequisites
@ -193,7 +193,7 @@ For comprehensive testing, including link checking:
task test
```
## Tips for Documentors
## Tips for Technical Writers
1. **Write in present tense** - "The system processes..." not "The system will process..."
2. **Use code blocks** with syntax highlighting

View file

@ -166,7 +166,7 @@ Documentation is now accessible:
### End-to-End Process
1. **Documentor writes content** (Markdown, LikeC4 models)
1. **Technical Writer writes content** (Markdown, LikeC4 models)
2. **Local testing** with `task serve` and `task test`
3. **Commit and push** to Git repository
4. **GitHub Actions triggered** on push to main
@ -336,4 +336,4 @@ The deployment process is automated and reliable:
**Kubernetes orchestration** - Reliable, scalable platform
**Simple rollback** - Easy to recover from issues
As a documentor, focus on content quality. The platform handles deployment automatically! 🚀
As a technicalWriter, focus on content quality. The platform handles deployment automatically! 🚀

View file

@ -3,7 +3,7 @@ title: "Quick Reference"
linkTitle: "Quick Reference"
weight: 60
description: >
Cheat sheet for common documentor tasks.
Cheat sheet for common technicalWriter tasks.
---
## Common Commands