Warto mieć plany i marzenia, szczególnie w kwestii wdrażania usprawnień w swojej pracy. Jako Tech Writerzy często snujemy wizje wykorzystania wspaniałych nowych technologii, które są na topie do przesunięcia naszego procesu tworzenia dokumentacji na wyższy poziom. Często jednak zapominamy o podstawach, bez których takie śmiałe wizje nie mają szansy powodzenia.
Zanim zaczniemy rewolucję, powinniśmy przyjrzeć się temu jak się sprawy mają w naszej organizacji. Tutaj przychodzi nam z pomocą model oceny dojrzałości (maturity model), dzięki któremu dowiemy się na jakim etapie rozwoju jest nasza dokumentacja. Dopiero po zrobieniu takiego "rachunku sumienia" będziemy mogli wykonać kolejny krok w postaci planowania usprawnień.
Rozmawiamy o przykładowym maturity modelu dla dokumentacji, zastanawiamy się co można zrobić, żeby przejść na wyższe poziomy, subiektywnie oceniamy innych i teoretyzujemy na temat przyszłości.
Dźwięki wykorzystane w audycji pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/).
Informacje dodatkowe:
- Konferencja soap!: https://soapconf.com/
- Etteplan: https://www.etteplan.com/pl
- "Maturity model", Wikipedia: https://en.wikipedia.org/wiki/Maturity_model
- "What is ContentOps", Heretto: https://heretto.com/blog/what-is-contentops/
- "Content strategy", Wikipedia: https://en.wikipedia.org/wiki/Content_strategy
- "Generative artificial intelligence", Wikipedia: https://en.wikipedia.org/wiki/Generative_artificial_intelligence
- "Help authoring tool (HAT)", Wikipedia: https://en.wikipedia.org/wiki/Help_authoring_tool
- "Darwin Information Typing Architecture (DITA)", Wikipedia: https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
- "Component Content Management System (CCMS)", Wikipedia: https://en.m.wikipedia.org/wiki/Component_content_management_system
- "About pull requests", GitHub : https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
- "Docs as Code", Write the Docs: https://www.writethedocs.org/guide/docs-as-code/
- "Lint (software)", Wikipedia: https://en.wikipedia.org/wiki/Lint_(software)
- GitHub Copilot: https://github.com/features/copilot
- "Style guide", Wikipedia: https://en.wikipedia.org/wiki/Style_guide
- Acrolinx: https://www.acrolinx.com/
- Schematron: https://www.schematron.com/
- Oxygen XML: https://www.oxygenxml.com/
- Visual Studio Code (VS Code): https://code.visualstudio.com/
- Jenkins: https://www.jenkins.io/
- "Microcontent", Wikipedia: https://en.wikipedia.org/wiki/Microcontent
- "What is "Intelligent Content"?, Storyblok: https://www.storyblok.com/mp/intelligent-content
- Docusaurus: https://docusaurus.io/
- "Large language model (LLM)", Wikipedia: https://en.wikipedia.org/wiki/Large_language_model
- "The economic potential of generative AI: The next productivity frontier", McKinsey Digital: https://www.mckinsey.com/capabilities/mckinsey-digital/our-insights/the-economic-potential-of-generative-ai-the-next-productivity-frontier#introduction