Swimm is built for engineers by engineers who get that documentation is integral to development, but it should not be a happiness drain. Swimm reduces the drift between the codebase and documentation by natively integrating with the IDE and CI/CD pipelines, making it easy to document on the fly and not as an afterthought.
Incremental creation from PRs and templates, with insights that suggest what part of the code should be documented and how urgently based on Git history.
By making documentation coverage of the code base visible, managers can see ‘documentation debt’ and make the work actionable / fix it, increasing both coverage and quality of docs
Making documentation readily accessible and transparent, and creation easy, spreads best practice and increases both coverage and quality of docs
Remote development upended usual collaboration and work routines, teams started looking for tools that can help them move fast in code areas.
Teams can combat silos and communicate with different types of docs that reflect context and decisions, including architecture designs, user manuals, release notes, training materials, and system overviews and more.
No more weeding through the docs to make progress, organize and maintain. Keeping docs on the source code makes it easy to find, and fix across any codebase or multiple repositories- and quick dive in seconds.
Remote by Design
Remote is here to stay - hybrid or full on. Implementing Swimm into the workflow, sprint and story, makes knowledge building, sharing and leveling up, remote by design.
With Swimm, you can launch an effective long-term technical bootcamp for a growing engineering team. You can add code snippets straight to your onboarding docs and tutorials or let onboarders practice on code to shorten the onboarding process immensely, and help them become more productive quicker.
Build onboarding plans that stay fresh without looking back: Tutorials, curated guides, or hands-on interactive training modules with hints, quizzes and other interactive elements. Share swimm content externally and embed content in Swimm documentation.
Swimm is also used to get teams and developers quickly ramped up to new code areas or new skills. Create generic onboarding playlists that teach new programming languages, create a certification module, or explain new features and more.
Go from you don’t know what you don’t know, to know what you don’t know. The importance of making ‘debt’ visible is to that it becomes actionable, plannable / refineable in sprints as work packages on the backlog.
Skills and Training
How Orca Made Onboarding Remote by Design
We recently ran a case study with Guardicore who onboarded new maintainers to their Open Source security breach tool - Infection Monkey.