top | item 40004367

Show HN: Annotate: Create walkthrough guides in the style of the Stripe docs

13 points| tip_of_the_hat | 1 year ago |annotate.dev

Hi HN!

Founder of Annotate here. Annotate lets you create step-by-step code walkthroughs, inspired by Stripe’s documentation (e.g., https://docs.stripe.com/checkout/quickstart) for your technical product. It comes with a React SDK that lets you embed walkthroughs directly in your docs or marketing materials. Check out an example walkthrough on the home page.

Why build Annotate? I’ve been in the dev tooling space for the last 5 years and have two main learnings:

1. Developers first look for a quick start guide when exploring a technical product. A great quick start increase developer adoption.

2. Developers typically prefer code snippets that closely resemble real-world applications over traditional longer-form docs.

Annotate helps you solve both above points.

Let me know if you have any questions or feedback!

3 comments

order

mlhpdx|1 year ago

This is helpful, but I’d evangelize (and probably buy) a system that linked external walkthroughs like this with my repo as an alternative to comments in the code, and triggered notifications when the walkthroughs go “stale” due to changes in the repo (suggesting automatic updates via LLM even better).

tip_of_the_hat|1 year ago

Just to clarify, this use case would be for internal code documentation rather than providing external walkthroughs for your users?