Stephan Lo
df439058a9
- 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.
1.5 KiB
1.5 KiB
| title | linkTitle | weight | description |
|---|---|---|---|
| Documentation About Documentation | Documentation | 10 | 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 technicalWriter role.
What is a Technical Writer?
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
- Testing locally before committing
- Following the CI/CD pipeline to production
Documentation Platform Architecture
Our documentation is built on a modern stack:
- Hugo with the Docsy theme for static site generation
- LikeC4 for architecture visualization
- Taskfile for local development automation
- GitHub Actions for continuous testing
- Edge deployment for hosting
System Overview
{{< likec4-view view="overview" project="documentation-platform" >}}
This high-level view shows all major components of the documentation platform.
Getting Started
Continue to the next sections to learn about:
- Local Development - How to work on documentation locally
- Testing - Quality assurance processes
- CI/CD Pipeline - Automated testing and deployment
- Publishing - How documentation reaches production