Skip to main content

​
Auto-Generated Documentation Platform

​
Overview

Your documentation writes itself. The Auto-Generated Documentation Platform converts feature specs, code, and product knowledge into clean end-user guides and distributor resources - automatically. Ship features without shipping doc debt. When you merge code, the platform generates branded manuals, FAQs, sales battle cards, and ROI calculators within an hour.

​
Step-by-Step Guide

​
For End Users: Finding Documentation

  1. Navigate to the docs site - Visit docs.fiftyknots.com and use the sidebar to browse by feature category (Getting Started, Briefing Wizard, Project Vaults, etc.).
  2. Search for your question - Use the search bar to find documentation across all features. Search indexes every page and returns results instantly.
  3. Select your platform version - If you need docs for a specific version, use the version selector to switch between releases. The default shows docs matching your current platform version.
  4. Follow the guide - Each feature page includes an overview, step-by-step instructions, common questions, troubleshooting, and links to related features.

​
For Developers: Generating Documentation

  1. Complete your feature spec - Write your feature spec in Docs/specs/NNN-feature-name/spec.md following the standard format with acceptance scenarios and edge cases.
  2. Run the doc generation pipeline - Execute the CLI command to trigger documentation generation, or merge to main to trigger automatically via GitHub Actions.
  3. Review generated content - The pipeline generates end-user docs and distributor resources in “pending review” state. Review for accuracy before first publish.
  4. Approve and publish - Once reviewed, approve the content. Updates to the spec automatically refresh published docs.

​
For Distributors: Accessing Sales Resources

  1. Log into the Coda portal - Access your distributor workspace with your registered account. Resources filter automatically to your region and tier.
  2. Browse feature battle cards - Find sales materials for each platform feature including value propositions, target personas, use cases, competitive positioning, and objection handling.
  3. Use ROI calculators - Open interactive calculators to input prospect parameters and generate branded ROI reports you can share with leads.
  4. Check “What’s New” - Review the auto-generated changelog to stay current on recent features and updates.

​
Common Questions

Q: How quickly do docs update when features change?
A: The pipeline runs within 1 hour of detecting spec changes. When you update a feature spec or merge code to main, corresponding documentation updates automatically and publishes to the docs site. Q: Can I customize generated documentation before it goes live?
A: Yes. All generated content enters “pending review” state before first publish per feature. You can edit, enrich, or adjust content before approving. Subsequent updates refresh automatically unless you flag specific sections for manual review. Q: What if my feature spec lacks enough detail for good docs?
A: The pipeline flags specs that are too thin for quality documentation rather than generating weak content. You’ll receive a notification to enrich the spec with more acceptance scenarios, edge cases, or UI descriptions before docs can be generated. Q: How does the system prevent internal information from appearing in external docs?
A: The pipeline includes a content classification layer that tags content as PUBLIC (end-user), PARTNER (distributor), or INTERNAL (team only). Pricing margins, competitive intelligence, and architecture decisions are automatically filtered from external outputs. Q: Can distributors see all platform features or just their tier?
A: The Coda portal uses row-level access control. Distributors see only resources matching their tier and region. Premium features and advanced battle cards remain hidden until a partner’s tier grants access.

​
Troubleshooting

Issue: Documentation doesn’t match the current platform version
Check the version selector at the top of the docs site. Ensure you’re viewing docs for your deployed version, not a newer release. If docs still don’t match, the feature may have shipped without triggering the pipeline - contact support to manually trigger regeneration. Issue: Generated battle card contains no competitive positioning
This happens when the feature spec lacks competitor analysis or differentiation details. Enrich the spec with competitive context, then re-run the pipeline. The system can’t fabricate competitive claims - it only transforms what exists in source materials. Issue: Pipeline fails with “insufficient source material” error
Your spec is too sparse for automated documentation. Add more acceptance scenarios, edge cases, and user-facing descriptions. Aim for at least 3-5 acceptance scenarios per user story and detailed edge case handling. Re-run the pipeline after enriching the spec. Issue: Distributor can’t access newly shipped feature resources
Check if the feature requires a tier upgrade for the distributor’s account. Some advanced features restrict access by partnership tier. Alternatively, the pipeline may still be processing - wait up to 1 hour after feature ship for resources to appear. Briefing Wizard - Use the Briefing Wizard to create detailed product briefs that feed into the documentation pipeline. Better briefs generate better docs. The wizard ensures your specs contain the structured information the doc generator needs. Data Room - Store and organize all feature specifications, PRDs, and technical documentation in the Data Room. The pipeline farms this knowledge base to generate external documentation, keeping your source of truth and public docs synchronized. SupaSherpa - Ask SupaSherpa questions about features and documentation. If you can’t find what you need in the docs site, SupaSherpa can surface relevant information from specs, code, and internal knowledge - and may suggest new FAQ entries based on your question patterns.