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:
parent
9e509ed265
commit
df439058a9
13 changed files with 147 additions and 147 deletions
|
|
@ -4,7 +4,7 @@ This folder contains LikeC4 architecture models that document the documentation
|
|||
|
||||
## Purpose
|
||||
|
||||
These models help new **Documentors** understand:
|
||||
These models help new **Technical Writers** understand:
|
||||
|
||||
- How the documentation platform works
|
||||
- The local development workflow
|
||||
|
|
@ -24,7 +24,7 @@ High-level view of the entire documentation platform, showing all major componen
|
|||
|
||||
### Local Development Workflow
|
||||
|
||||
How a documentor works locally with content, Taskfile, and Hugo server.
|
||||
How a technicalWriter works locally with content, Taskfile, and Hugo server.
|
||||
|
||||
### CI/CD Pipeline
|
||||
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ specification {
|
|||
model {
|
||||
|
||||
// === Personas ===
|
||||
documentor = person 'Documentor' {
|
||||
technicalWriter = person 'Technical Writer' {
|
||||
description 'Content creator and maintainer of the developer platform documentation'
|
||||
technology 'Hugo, Markdown, LikeC4'
|
||||
}
|
||||
|
|
@ -151,16 +151,16 @@ deploymentEnv = system 'Deployment Environment' {
|
|||
}
|
||||
}
|
||||
|
||||
// === Relationships: Documentor Workflow ===
|
||||
documentor -> contentRepo.contentPages 'writes documentation' {
|
||||
// === Relationships: Technical Writer Workflow ===
|
||||
technicalWriter -> contentRepo.contentPages 'writes documentation' {
|
||||
description 'Creates and updates Markdown content'
|
||||
}
|
||||
|
||||
documentor -> contentRepo.archModels 'creates architecture models' {
|
||||
technicalWriter -> contentRepo.archModels 'creates architecture models' {
|
||||
description 'Defines C4 models with LikeC4 DSL'
|
||||
}
|
||||
|
||||
documentor -> taskfile 'executes local tasks' {
|
||||
technicalWriter -> taskfile 'executes local tasks' {
|
||||
description 'task serve, task build, task test'
|
||||
}
|
||||
|
||||
|
|
@ -244,7 +244,7 @@ deploymentEnv.k8sCluster.docDeployment -> deploymentEnv.k8sCluster.docService 'e
|
|||
description 'Port 80'
|
||||
}
|
||||
|
||||
documentor -> deploymentEnv.k8sCluster.docService 'views published docs' {
|
||||
technicalWriter -> deploymentEnv.k8sCluster.docService 'views published docs' {
|
||||
description 'HTTPS access to live documentation'
|
||||
}
|
||||
|
||||
|
|
@ -256,11 +256,11 @@ views {
|
|||
|
||||
view overview of docPlatform {
|
||||
title 'Documentation Platform Overview'
|
||||
description 'High-level overview of the Hugo-based documentation platform for documentors'
|
||||
description 'High-level overview of the Hugo-based documentation platform for technicalWriters'
|
||||
|
||||
include *
|
||||
|
||||
style documentor {
|
||||
style technicalWriter {
|
||||
color green
|
||||
}
|
||||
style docPlatform {
|
||||
|
|
@ -270,9 +270,9 @@ views {
|
|||
|
||||
view localDevelopment of docPlatform {
|
||||
title 'Local Development Workflow'
|
||||
description 'How a documentor works locally with the documentation'
|
||||
description 'How a technicalWriter works locally with the documentation'
|
||||
|
||||
include documentor
|
||||
include technicalWriter
|
||||
include docPlatform
|
||||
include docPlatform.contentRepo -> *
|
||||
include docPlatform.hugoSite
|
||||
|
|
@ -280,7 +280,7 @@ views {
|
|||
include docPlatform.taskfile
|
||||
include docPlatform.devServer
|
||||
|
||||
style documentor {
|
||||
style technicalWriter {
|
||||
color green
|
||||
}
|
||||
style docPlatform.taskfile {
|
||||
|
|
@ -317,7 +317,7 @@ views {
|
|||
include deploymentEnv
|
||||
include deploymentEnv.edgeConnect
|
||||
include deploymentEnv.k8sCluster -> *
|
||||
include documentor
|
||||
include technicalWriter
|
||||
|
||||
style deploymentEnv {
|
||||
color muted
|
||||
|
|
@ -328,10 +328,10 @@ views {
|
|||
}
|
||||
|
||||
view fullWorkflow {
|
||||
title 'Complete Documentor Workflow'
|
||||
title 'Complete Technical Writer Workflow'
|
||||
description 'End-to-end view from content creation to published documentation'
|
||||
|
||||
include documentor
|
||||
include technicalWriter
|
||||
include docPlatform.contentRepo
|
||||
include docPlatform.taskfile
|
||||
include cicdPipeline.githubActions
|
||||
|
|
@ -339,7 +339,7 @@ views {
|
|||
include deploymentEnv.edgeConnect
|
||||
include deploymentEnv.k8sCluster
|
||||
|
||||
style documentor {
|
||||
style technicalWriter {
|
||||
color green
|
||||
}
|
||||
style docPlatform.taskfile {
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
model {
|
||||
|
||||
// === Personas ===
|
||||
documentor = person 'Documentor' {
|
||||
technicalWriter = person 'Technical Writer' {
|
||||
description 'Content creator and maintainer of the developer platform documentation'
|
||||
technology 'Hugo, Markdown, LikeC4'
|
||||
}
|
||||
|
|
@ -116,16 +116,16 @@ deploymentEnv = system 'Deployment Environment' {
|
|||
}
|
||||
}
|
||||
|
||||
// === Relationships: Documentor Workflow ===
|
||||
documentor -> contentRepo.contentPages 'writes documentation' {
|
||||
// === Relationships: Technical Writer Workflow ===
|
||||
technicalWriter -> contentRepo.contentPages 'writes documentation' {
|
||||
description 'Creates and updates Markdown content'
|
||||
}
|
||||
|
||||
documentor -> contentRepo.archModels 'creates architecture models' {
|
||||
technicalWriter -> contentRepo.archModels 'creates architecture models' {
|
||||
description 'Defines C4 models with LikeC4 DSL'
|
||||
}
|
||||
|
||||
documentor -> taskfile 'executes local tasks' {
|
||||
technicalWriter -> taskfile 'executes local tasks' {
|
||||
description 'task serve, task build, task test'
|
||||
}
|
||||
|
||||
|
|
@ -209,7 +209,7 @@ deploymentEnv.k8sCluster.docDeployment -> deploymentEnv.k8sCluster.docService 'e
|
|||
description 'Port 80'
|
||||
}
|
||||
|
||||
documentor -> deploymentEnv.k8sCluster.docService 'views published docs' {
|
||||
technicalWriter -> deploymentEnv.k8sCluster.docService 'views published docs' {
|
||||
description 'HTTPS access to live documentation'
|
||||
}
|
||||
|
||||
|
|
@ -221,11 +221,11 @@ views {
|
|||
|
||||
view overview of docPlatform {
|
||||
title 'Documentation Platform Overview'
|
||||
description 'High-level overview of the Hugo-based documentation platform for documentors'
|
||||
description 'High-level overview of the Hugo-based documentation platform for technicalWriters'
|
||||
|
||||
include *
|
||||
|
||||
style documentor {
|
||||
style technicalWriter {
|
||||
color green
|
||||
}
|
||||
style docPlatform {
|
||||
|
|
@ -235,9 +235,9 @@ views {
|
|||
|
||||
view localDevelopment of docPlatform {
|
||||
title 'Local Development Workflow'
|
||||
description 'How a documentor works locally with the documentation'
|
||||
description 'How a technicalWriter works locally with the documentation'
|
||||
|
||||
include documentor
|
||||
include technicalWriter
|
||||
include docPlatform
|
||||
include docPlatform.contentRepo -> *
|
||||
include docPlatform.hugoSite
|
||||
|
|
@ -245,7 +245,7 @@ views {
|
|||
include docPlatform.taskfile
|
||||
include docPlatform.devServer
|
||||
|
||||
style documentor {
|
||||
style technicalWriter {
|
||||
color green
|
||||
}
|
||||
style docPlatform.taskfile {
|
||||
|
|
@ -282,7 +282,7 @@ views {
|
|||
include deploymentEnv
|
||||
include deploymentEnv.edgeConnect
|
||||
include deploymentEnv.k8sCluster -> *
|
||||
include documentor
|
||||
include technicalWriter
|
||||
|
||||
style deploymentEnv {
|
||||
color muted
|
||||
|
|
@ -293,10 +293,10 @@ views {
|
|||
}
|
||||
|
||||
view fullWorkflow {
|
||||
title 'Complete Documentor Workflow'
|
||||
title 'Complete Technical Writer Workflow'
|
||||
description 'End-to-end view from content creation to published documentation'
|
||||
|
||||
include documentor
|
||||
include technicalWriter
|
||||
include docPlatform.contentRepo
|
||||
include docPlatform.taskfile
|
||||
include cicdPipeline.githubActions
|
||||
|
|
@ -304,7 +304,7 @@ views {
|
|||
include deploymentEnv.edgeConnect
|
||||
include deploymentEnv.k8sCluster
|
||||
|
||||
style documentor {
|
||||
style technicalWriter {
|
||||
color green
|
||||
}
|
||||
style docPlatform.taskfile {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue