New top story on Hacker News: Show HN: Dev-Docs – A tool that helps you document as you code
Show HN: Dev-Docs – A tool that helps you document as you code
9 by andrewdevdocs | 2 comments on Hacker News.
Hi all, Super excited to share that I am building Dev-Docs, and I wanted to create a post to get other developers' thoughts. Background: Developers know how important it is to document their codebases, but often, it's an afterthought that ends up taking a lot of time and effort. That's where Dev-Docs comes in - a solution that helps developers document as they code, making the process easier and more efficient. Features: Dev-Docs handles both internal documentation for teams and external documentation around APIs and codebases for customers and partners. Internal Documentation: Dev-Docs makes it easy for engineers to document their code, right within their editor. This way, they can easily document the code they're working on, without having to switch between multiple tools. Think of it as a mini local notion that lives within vs code. External API and Codebase Documentation: Developers can also use Dev-Docs to document their external APIs and codebases, making it easier for their customers and partners to understand how the code works. Quick demo(From December): https://youtu.be/fmcgw3MkW4E Currently it is live but I am going to try to refine it a bit during this month and hopefully market a more open launch. In the meantime I would love some feedback on the video/product(hopefully none that obliterates my identity and all of my self-esteem). :') Additionally feel free to dm on linkedin if you have direct feedback or want to start using the rough version of it: https://ift.tt/dsHe7gz . Thanks!
9 by andrewdevdocs | 2 comments on Hacker News.
Hi all, Super excited to share that I am building Dev-Docs, and I wanted to create a post to get other developers' thoughts. Background: Developers know how important it is to document their codebases, but often, it's an afterthought that ends up taking a lot of time and effort. That's where Dev-Docs comes in - a solution that helps developers document as they code, making the process easier and more efficient. Features: Dev-Docs handles both internal documentation for teams and external documentation around APIs and codebases for customers and partners. Internal Documentation: Dev-Docs makes it easy for engineers to document their code, right within their editor. This way, they can easily document the code they're working on, without having to switch between multiple tools. Think of it as a mini local notion that lives within vs code. External API and Codebase Documentation: Developers can also use Dev-Docs to document their external APIs and codebases, making it easier for their customers and partners to understand how the code works. Quick demo(From December): https://youtu.be/fmcgw3MkW4E Currently it is live but I am going to try to refine it a bit during this month and hopefully market a more open launch. In the meantime I would love some feedback on the video/product(hopefully none that obliterates my identity and all of my self-esteem). :') Additionally feel free to dm on linkedin if you have direct feedback or want to start using the rough version of it: https://ift.tt/dsHe7gz . Thanks!
Comments
Post a Comment