Patrick.Sy/website-and-documentation
1
0
Fork 0
forked from DevFW-CICD/website-and-documentation
Code Pull requests Activity

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

Browse source 
- 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
Download patch file Download diff file Expand all files Collapse all files

10
README-developer.md
View file

@ -29,7 +29,7 @@ Devbox automatically installs all required tools:
- htmltest
- go-task
> **Note:** For content contributors, see [README-documentor.md](./README-documentor.md) for a simplified guide.
> **Note:** For content contributors, see [README-technicalWriter.md](./README-technicalWriter.md) for a simplified guide.
## 📚 Technology Stack
@ -302,7 +302,7 @@ hugo version
├── Dockerfile # Multi-stage container build
├── README.md # Main README
├── README-developer.md # This file
├── README-documentor.md # Guide for content contributors
├── README-technicalWriter.md # Guide for content contributors
├── README-likec4.md # LikeC4 architecture modeling guide
└── RELEASE.md # Release process documentation
```
@ -374,7 +374,7 @@ Parameters:
- `project` - `"architecture"` or `"documentation-platform"`
- `title` - Optional custom title
See [README-documentor.md](./README-documentor.md) for detailed LikeC4 workflow.
See [README-technicalWriter.md](./README-technicalWriter.md) for detailed LikeC4 workflow.
## 🧪 Testing
@ -469,9 +469,9 @@ devbox shell --refresh
- [Devbox Documentation](https://www.jetify.com/devbox/docs/)
**Project-specific guides:**
- [README-documentor.md](./README-documentor.md) - Content contributor guide
- [README-technicalWriter.md](./README-technicalWriter.md) - Content contributor guide
- [TESTING.md](./TESTING.md) - Detailed testing documentation
- [DOCUMENTOR-GUIDE.md](./DOCUMENTOR-GUIDE.md) - Quick reference for documentors
- [DOCUMENTOR-GUIDE.md](./DOCUMENTOR-GUIDE.md) - Quick reference for technicalWriters
## 🤝 Contributing