Writing technical documentation
Writes manuals, support documentation and decision records that a reader without prior knowledge can follow step by step and that stay current.
W jaki sposób serwis hrmforce to mierzy
- Metoda oceny
- Work sample test · rho 0.33 (SD 0.09)
- hrmforce narzędzie
- Work sample test, Portfolio
- Kompetencje (50-ramowe)
- Written communication skills
- Możliwość szkolenia
- high
- Prognoza popytu na lata 2026–2030
- stable
The candidate performs a representative work sample under standardised conditions.
Kotwice behawioralne
| Poziom | Zachowanie na tym poziomie |
|---|---|
| N1 Guided | Completes a documentation template with the steps of a task and has the text checked by a colleague. works under supervision and follows instruction · routine, one variable at a time · own task |
| N3 Proficient | Writes complete documentation for a system or process, tests it with an unfamiliar reader and maintains versions. sets own approach and seeks input proactively · several variables, some ambiguity · own team or process |
| N5 Leading | Sets the organisation's documentation standard and ensures documentation is part of every delivery. sets the standard and the policy · strategic, under high uncertainty · organisation, value chain or profession |
N2 i N4 celowo nie zostały przypisane do konkretnych punktów odniesienia. Oceniający umieszczają je pomiędzy punktami odniesienia, zgodnie z konwencją O*NET.
Podstawowe umiejętności
Umiejętności te dziedziczą ścieżkę oceny oraz punkty odniesienia behawioralne tej konstrukcji.
| T | Umiejętności | Definicja | Prognoza popytu na lata 2026–2030 |
|---|---|---|---|
| V | Writing a user manual User manual | Writes step by step instructions with screenshots that a new user can follow without help. | declining |
| V | Writing operations documentation Runbook · Operations documentation | Describes installation, settings, dependencies and recovery steps so an administrator can take over the system. | stable |
| V | Writing a README README | Describes purpose, installation, usage and contact point of a project in a file next to the code. | stable |
| V | Writing API documentation API documentation | Describes per call the parameters, example requests, responses and error codes with working examples. | rising |
| V | Writing an architecture document Architecture document | Describes components, data flows and choices of a system with diagrams that match reality. | stable |
| V | Writing release notes Release notes | Describes per version what changes for users and administrators and what they need to do about it. | stable |
| T | Diagramming a process or system Diagramming | Draws a flow or system diagram with unambiguous symbols that makes the working clear in one view. | stable |
| V | Keeping documentation current Documentation maintenance | Updates documentation with every change, monitors ownership and removes what is no longer accurate. | stable |
| V | Writing a knowledge base article Knowledge base article | Writes a short article with problem, cause and solution that the service desk can use directly. | declining |