A missing link between Documentation and Code

HastyDocs provides you tooling to use your documentation in the best ways!

Thanks for submitting!

 

How it works:

  1. Tag a text imported from your documentation apps.

  2. Find a right place in your repo and tag a code connected with this documentation.

  3. Create a link between the two. Now it is easily visible. 

  4. GitHub/GitLab BOT monitors code that was connected and automatically notifies you when the code changes. 

What can be linked:

  1. Connect specific lines of code, method, class but also whole packages or multiple files in a package - go beyond docstring limitations.

  2. Create dynamic code examples by linking code instead of copy pasting it multiple times.

  3. Give broader context to existing code snippets by linking full methods, test cases or whole modules.

  4. Link configuration and deployment files to have up-to-date documentation.

  5. Link backup, security and other policies to relevant places in your code.

Use Cases 

Benefits:

Quickly find right place in repo

If you use swagger 

  • 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.

Track changes in documentation

We know that it takes a lot of resource to keep your documentation up-to-date and still parts of it are out-of-date. Thanks to links to code we will notify right people when the linked code changes, so more parts of documentation will be up to date. Your clients will not be confused with your docs anymore, your brand will have better perception and you will need to provide less support to answer their questions. 

Benefits:

  • Get Automatic notification to review docs! 

  • Save a lot of time of developers and technical writes spent of 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 and expenses! 

Benefits:

Monitor Internal Policies

We know that you have to stay compliant with many external policies such as GDPR, ISO or other more industry specific like AML, etc. You also have many internal policies such as Backup Policy or Security Policy which are super important to follow 100% of the time. Thanks to links with the code we can help you automate this process.

  • Get Automatic notification to review code when it is linked with all your policies.

  • Make it easy for your developers to find parts of the code that are linked to your policies in one view in our Web App.

  • Increase your compliance with all your policies.

  • Easily verify alignment of policies and their implementation.

Thanks for submitting!

 
 

Features:

​WEB APP

  • Links between documentation and code in our Web App

  • 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.

Contact Us

Thanks for submitting!