Требования
Требования к техническому писателю(документирование архитектуры ПО и API)Документирование API● Понимание принципов работы REST, SOAP, GraphQL, gRPC, WebSocket.● Умение работать с форматами JSON, YAML и XML.● Опыт проектирования и документирования API с использованием современныхстандартов: OpenAPI 3.0+ (инструменты Swagger UI, Redoc) и AsyncAPI (дляброкеров сообщений и асинхронного взаимодействия).● Опыт работы с инструментами тестирования API (Postman, Bruno).● Навыки подготовки и сопровождения документации по подходу Docs-as-Code.● Опыт работы с генераторами статических сайтов (MkDocs, Docusaurus, Redocly,Hugo, Sphinx, VitePress).● Понимание механизмов аутентификации и авторизации (OAuth 2.0, JWT, APIKey, Basic Authentication).● Умение описывать API, эндпоинты, параметры запросов, ответы, коды ошибок ипримеры использования.Документирование архитектуры программного обеспечения● Понимание архитектурных подходов: монолитная, микросервисная,событийно-ориентированная (EDA).● Понимание принципов интеграции систем через API, брокеры сообщений(например, Kafka, RabbitMQ) и базы данных.● Опыт документирования взаимодействия сервисов и потоков данных.● Владение нотациями UML и C4 Model.● Умение создавать и поддерживать:○ диаграммы последовательности (Sequence Diagram);○ диаграммы компонентов (Component Diagram);○ диаграммы сущностей и связей (ERD);○ архитектурные схемы по модели C4.● Уверенное владение инструментами визуализации в парадигмеDiagrams-as-Code: PlantUML, Mermaid, Structurizr.● Будет плюсом: опыт работы с графическими редакторами и whiteboards(Draw.io, Miro) для первичного проектирования.Docs-as-Code● Уверенное владение Git (GitLab/GitHub): ветвление, Merge/Pull Request,разрешение конфликтов.● Понимание принципов CI/CD и автоматической публикации документации.● Владение Markdown, AsciiDoc и/или reStructuredText (rST).● Опыт ведения документации в репозиториях совместно с командой разработки(соблюдение стайл-гайдов, линтинг). Общие требования● Понимание жизненного цикла разработки программного обеспечения (SDLC).● Умение взаимодействовать с архитекторами, разработчиками, аналитиками итестировщиками.● Навыки анализа технической информации и преобразования её вструктурированную документацию.● Опыт сопровождения и актуализации технической документации на протяжениижизненного цикла продукта.
