Video transcript / Prevail
Project walkthrough transcript.
The narration for the Prevail documentation and publishing walkthrough. Select a timestamp to play that section.
Three kinds of documentation
Prevail's documentation served product users, developers, and internal teams. Product guides, configuration and integration documentation, and internal procedures addressed their different tasks.
Docs as code
The docs-as-code workflow kept documentation in Git. Each writer worked on a separate branch, and GitHub Actions built a preview of the site.
Review before approval
Writers shared those previews with subject-matter experts. Reviewers checked the rendered pages and gave feedback before approving changes.
Merge and promotion
Approved changes were merged into development, then promoted through staging to production.
Custom Jekyll development
Custom Jekyll extensions added callouts for warnings and notes, cards for related pages, and a table of contents that supported both second-level and third-level headings.
Project contributions
The documentation was a shared effort. A complete docs-as-code setup, review and publishing workflows, and custom site features supported the team's writing.
Reading the documentation
Readers had task instructions, links to related pages, and a table of contents for finding the relevant section.
Maintaining the documentation
For writers, reusable site features and documented publishing steps provided a consistent way to prepare, review, and release updates.
Where to go next
The deliverables: product guides, developer documentation, internal procedures, custom Jekyll features, and a docs-as-code publishing workflow. Explore the Prevail project, then start a conversation at youngcopy.com.