Inspiration
Online documentation can sometimes be hard to navigate, especially as first year CS students. Experiencing this struggle first hand gave us the motivation to make this idea a reality.
What it does
Takes a specifically formatted text file and searches through it based on user input and the keywords assigned to each function to present the user with the documentation they are looking for. You can also start with a blank file and just add functions to it, creating your own documentation from scratch to search through.
How we built it
We are all 1st year comp-sci students with only a couple months of experience so we used the numerous methods we have learned in the past couple months and applied them to this program. The most vital was probably the use of dictionaries and txt file reading/writing
Challenges we ran into
Couldn't quite figure out how our 'search engine' would run but then discovered we could use Jaccard Similarity index's comparing the user inputs with the key-words associated with each function.
Accomplishments that we're proud of
The fact this this is actually applicable and something we can use to help improve our programming skills in the future.
What we learned
That even with small amounts of programming knowledge, you can make something useful.
What's next for Individualized Documentational Tool (IDT)
Adding different categories of documentation, and better output formatting.
Log in or sign up for Devpost to join the conversation.