Back to selected work
Featured project / Prevail
Documentation people could use. A publishing system the team could maintain.
The work connected product guides, developer documentation, and internal procedures with a review and publishing workflow built for an evolving documentation site.
Publishing workflow
Documentation updatePreview and publication
Ready to publish01Draft updatedWriter
02Preview builtGitHub Actions
03Review completedPull request
04Production publishedApproved changes
User guidesDeveloper documentationInternal procedures
The project
Writing and publishing were part of the same system.
Publishing more documentation does not help when readers cannot follow the instructions or writers cannot safely update the site. The project addressed both sides: the content people needed and the workflow the team used to review and release changes.
Writers could generate a preview for review before publication. Pull-request instructions documented how changes moved through development, staging, and production.
Project walkthrough
See the documentation and publishing workflow.
Follow a documentation update through preview, review, and publication, then see the custom Jekyll features.
Workflow and Jekyll feature illustrationsRead the transcript
Documentation architecture
Different readers. Connected content.
The project covered customer-facing and internal tasks without presenting the documentation as one undifferentiated library.
User documentation
Task-based instructions for people using Prevail’s features and workflows.
Developer documentation
Configuration and integration instructions, including SSO and SAML.
Internal procedures
Repeatable instructions for team processes that needed consistent execution and maintenance.
Documentation samples
Product tasks and session preparation.
Two Prevail documentation pages show task instructions, reference tables, and preparation checks.
Publishing workflow
Review changes before publication.
The team used docs as code: writers worked on separate Git branches, and GitHub Actions built previews of the Jekyll site. Pull requests recorded feedback and approval before changes merged into development and advanced through staging to production.
- 01
Update the documentation.
A writer changes the relevant guide, procedure, or reusable site content.
- 02
Build a preview.
GitHub Actions produces a version reviewers can review in context.
- 03
Review the change.
The pull request keeps discussion and approval tied to the proposed update.
- 04
Publish the approved work.
The documented workflow separates development, staging, and production.
Documentation site system
Reusable features for organizing and maintaining content.
The work extended the Jekyll site so writers could use consistent presentation patterns without rebuilding them on every page.
Callouts
Reusable emphasis for notes, warnings, and task-critical information.
Content cards
Structured groups of related paths and resources.
Table-of-contents control
Page-level control over which heading levels appeared in navigation.
Role and collaboration
A shared documentation effort with clearly defined implementation work.
The documentation was a shared effort. My role focused on the review and publishing workflow, custom site extensions, and contributions to the content and procedures that used them.
The case study describes documentation types, review stages, publishing behavior, and maintainable site features. Traffic, conversion, and support metrics were not measured for this presentation.
Current capabilities
Documentation and tools for your next project.
The Prevail project combined product documentation, internal procedures, and a review and publishing workflow. Today, Young Copy can build branded onboarding experiences, interactive information tools, and developer documentation systems.
Branded onboarding experiences
A structured site that introduces the product, teaches essential tasks, and keeps supporting information connected as users progress.
Interactive information tools
Purpose-built applications for field mappings, validation, filtering, review decisions, and structured team handoffs.
Developer documentation systems
API quickstarts, integration guides, reference content, publishing workflows, and maintenance instructions designed as one system.
These capabilities describe what Young Copy can offer on new projects. They are not additional deliverables from the Prevail project.
Your documentation system
Does the content work, and can your team keep it working?
Tell me what people need to understand and how the documentation needs to be reviewed, published, and maintained.