Description
Our technical writing team is responsible for developing documentation for the software products that are part of the Platform V digital platform. The platform consists of various front-end and back-end solutions used for software development, data processing, integrations, security, and more. The products are in industrial operation and are actively evolving.
The product is a comprehensive solution consisting of a set of components. The product is accompanied by overall product documentation and separate sets of documentation for each component. Component documentation is created by the component development teams.
The set of software documentation for the product includes documents necessary for the development, installation, operation, and maintenance of this product. That is, we create documents for various categories of users.
We are looking for a technical writer with experience creating software documentation for developers and software administrators, as well as organizing documentation processes (Lead). Communication skills are important to us, as the technical writer closely interacts with component development teams and with customers.
Main technology stack: Git, Markdown, MyST, PlantUML, VSCode.
Responsibilities
Your tasks:
- developing documentation according to the "Docs as Code" approach: architecture descriptions, software deployment and administration guides, security guides, developer guides, and other software documents
- undergoing expert review of documentation and revising documentation based on the results
- building and preparing documentation for publication on internal and external portals, building documentation distributions for delivery to customers
Lead functions:
- participation in developing architectural requirements regarding making changes to the product and its component documentation, monitoring their compliance
- planning timelines for preparing component documentation with component teams and the product release team, monitoring adherence to deadlines. Organizing processes for timely and high-quality preparation of documentation
- analyzing defects in product and component documentation, planning and monitoring their resolution
- collecting feedback from customers, processing it, and planning documentation improvements.
Requirements
We expect you to have:
- experience creating software documentation for IT specialists: developer guides, architecture descriptions, software deployment and administration guides (2+ years)
- experience organizing documentation processes within a team
- advanced skills in preparing documentation according to the "Docs as Code" approach, working with developer tools (IDEA/VSCode, Jenkins, Nexus, Git)
- experience with task trackers, wiki systems
- ability to work in a distributed team
- experience with AI tools for creating documentation, prompt engineering.
Will be a plus:
- knowledge of markup languages Markdown and ReStructuredText, MyST
- understanding of UML notation
- skills in building documentation according to the single source of documentation concept
- knowledge of cloud service technology stack: Docker, K8S, principles of software microservice architecture
- knowledge of API (API types, corresponding specifications, display tools)
- experience organizing a product knowledge base, writing instructions for company processes and tools
- experience with AI tools for creating documentation, prompt engineering.
Conditions
Working at SberTech means:
- hybrid work format
- annual bonus and yearly salary review
- accredited IT company status
- extended private health insurance from day one and preferential insurance for family
- Sber corporate university, internal educational platform, participation in IT conferences
- 90 days of remote work from any region of the Russian Federation
- preferential mortgage at Sberbank, SberPrime+ subscription, discounts from partners and services of the group of companies.
