Speed == Right tools, right info
I stumbled on a website called DeepWiki. It looks like an AI agent built on Devin. What caught my attention was it claimed it would build engineering documentation, wiki style, from your github repos. I thought I would give it a try and see what came of it.
At a cursory glance, I will say I was impressed. It recongized architecture patterns like data layers, service layers and system patterns like hub and spoke and design patterns like strategy pattern or service locator pattern. It built ERD diagrams, swim lanes. architecture overview charts.
I went on to ask Deepwiki "what it would take to finish the plugin?" support for my blockchain project. And it gave me list of places where code would need to changed. Again, I didn't spend a lot of time analysing the results. At at first glance, I felt the results were a great starting point.
I feel this is tool worth exploring more. Engineering teams struggle with keeping documentation up to date. And manually building the content DeepWiki built is time consuming. Deepwiki might be one of those tools that help improve the speed and quality of developing software.
I know I tend to create documents while and I build my project(s) and those documents are part of the github repos I used with DeepWiki. It would be interesting to try it with a repo where no documentation exists at all, just code.
No comments yet. Be the first to comment!
To leave a comment, please log in.