Always have up-to-date docs thanks to automatic tests!

HastyDocs creates a missing link between code and documentation that helps you save time and improve quality of your docs!

Thanks for submitting!

 

How it works?

  1. HastyDocs connects to your repositories with code and documentation (we have read-only access).

  2. By tagging parts of the code and documentation you create a link between them.

  3. We send you a notification once the code changes, so you know which parts of the docs to review. You no longer have to manually go through all the changes in the code base.

  4. As we take link context into account you also get notified once the content around your link changes. This way you are notified not only when your linked code changes but also when someone extends existing functionality.

What might be worth linking?

  1. API reference,

  2. screenshots and diagrams,

  3. code examples and use-cases descriptions,

  4. description of particular functionalities which rely on the code but do not qualify as an API reference,,

  5. internal tech-onboarding tutorials,

  6. configuration and deployment instructions,

  7. backup, security and other policies which have a reflection in the code,

  8. anything that gets easily and often outdated in your docs.

Alphabet Cubes

Benefits:

Keep your Developer Portal always up-to-date.

We know that your developer portal is one of the most important parts of making your customer successful. 

That is why we have created a tool that will let you test the content of your docs automatically, so that your docs are always up-to-date and your customers happy. 

  • Save a lot of time of developers and technical writers that they spend on keeping docs up-to-date in a manual and error-prone way.

  • Let developers focus on writing code instead of keeping the docs up-to-date. 

  • Keep more of your external documentation up-to-date so your customers will have less problems with it and your brand will have better perception.

  • Less  out-of-date docs also means less support tickets. 

Create a better internal technical documentation

Your technical documentation describes your code base, which makes it natural to link them together, so:

1) when developers read code they can quickly see relevant parts of documentation 

2) when developers or users read documentation, they can easily find right part of the code base.

3) keeping technical docs up-to-date is easy!

Pencil

Benefits:

  • Faster onboarding of new developers and faster ramp-up time when current developers switch teams or work on new features.

  • Savings for the company. 

  • Higher satisfaction of your development team due to better code comprehension.

  • Improved asynchronous communication as the codebase is easier to understand.

Thanks for submitting!

 
 

Features and Roadmap:

​Web and On-Premise Applications

  • One Unified view of code next to your documentation

  • Integration with main wiki tools such as Confluence or Google Docs to easily import your internal documentation.

​Github/GitLab Integrations

  • Integration with GitHub/GitLab to easily import your public documentation and code.

  • GitHub BOT that automatically notifies to review documentation when the code changes.

  • Easy integration with docs-as-code workflow

Contact Us

Thanks for submitting!