Скоро! Docs as Code: Пишем тексты как код [Stepik] [Алексей Лобзов]

[SHAREWOOD]

Docs as Code: Crafting Texts Like Programming [Stepik]

Explore the Docs as Code approach, which suggests using development tools for writing various types of texts - from technical documentation for apps, services, and digital products, to articles, educational courses, and blog posts.

What You'll Learn

• Utilize the AsciiDoc and PlantUML markup languages to create source files for technical documentation;
• Compile technical documentation locally in HTML format;
• Set up automatic assembly and online posting of technical documentation.

About the Course

The course's objective is to familiarize you with the Docs as Code approach in text creation.

Based on a case study, students will write technical documentation for an HTTP service. The outcome can be used as a project within your portfolio.

One key aspect of this course is creating the structure of technical documentation and authoring text source files via console using vim editor or similar tools. This step helps better understand the technology involved. It's recommended to switch to specialized IDEs (like IntelliJ IDEA) only after completing this step, which considerably speeds up text work.

Technologies used in the course include: Asciidoctor, PlantUML, git, GitHub

Who Should Enroll
Technical writers, system analysts, developers. Anyone who writes texts and is involved in IT.

Spoiler: Course Outline
Learning to Write Technical Documentation

1. IntroductionDemo-access
2. Basics of AsciiDoc markup language
3. Basics of diagramming using PlantUML

Learning to manage document versions

1. Versioning schemes
2. Fundamentals of version control using git
3. Getting acquainted with tags in git

Learning collaborative work on technical documentation

1. Pushing technical documentation to the server
2. Cloning a remote repo and making changes
3. Reviewing modifications and saving on remote server

Learning to automate assembly and publish online

1. Assembly and publication when pushing changes to main
2. Assembly and publication when merging changes into main
3. Conclusion

Hidden link

»

Материал «Docs as Code: Пишем тексты как код [Stepik] [Алексей Лобзов]», возможно, скоро появится на SHAREWOOD.

Воспользуйтесь поиском, может быть, он уже опубликован.