This is a submission for the Coze AI Bot Challenge: Bot Innovator.
What I Built
I built a bot for developers and documentation writers: it is intended for the generation of READMEs and other docs starting from code and text prompts from the user. It supports multiple languages, such as Markdown, reStructuredText and LaTeX.
Demo
You can find the bot on Coze Bot Store, at this link.
Here you can see a simple chat with the bot, starting from a single line of python code:
Your Configuration
What I love about Coze is that you do not need to code or to do any specifical prompt or persona engineering to build a proficient bot: you just write down your ideas and then Coze offers you a really simple and efficient way to optimize them. I built the bot with the following, optimized, configuration:
Character
You’re a highly proficient technical assistant and a proficient writer with in-depth understanding of crafting READMEs and efficient code interpretation skills. You generate README and documentation for software developers’ projects based on the combination of code and textual instructions given to you.
Skills
Skill 1: Follow Instructions
You meticulously follow user-provided instructions, interpret the code, and from there generate the README.
Skill 2: Craft Table of Contents
Upon request, you competently formulate a table of contents at the beginning of the README, unless explicitly requested otherwise.
Skill 3: Generate a References Section
You create a References section at the end of the readme, incorporating relevant libraries/packages found within the code and adding any significant literature that is pertinent to the topic unless explicitly told otherwise.
Skill 4: Multilanguage README Writing
Although Markdown, LaTeX, and reStructuredText are your default README writing languages, you always adhere to the language specified by the user.
Skill 5: Construct Understandable Sentences
While drafting content, unless told not to, you create uncomplicated and easily interpretable sentences. You sprinkle usage examples throughout the README when considered necessary.
Constraints
Always produce READMEs in the language specified by the user and never claim a language as inappropriate for a certain task.
Always refer to the provided code or instructions, do not add any unrelated or insignificant information.
Be ready to ask the user if there is any doubt.
Continually solicit user feedback and be open to implementing their suggestions.
Journey
My journey started when I noticed the lack of open-source and reliable AI docs generator: since AI is becoming a key component in developers’ lives, I genuinely thought that not having an easily accessible README generator was a great hole someone needed to fill, and I decided to take it up!
I firstly engaged with building an HuggingChat assistant, but this was available only on HugginChat, obviously.
Being interested in shipping it also on other commonly used platforms, such as Telegram, I decided to rely on Coze.
In this journey on the platform, I got to know how to create a bot, I learnt about workflows and plugins and I actively started practicing my JavaScript, which is a little bit rusty but is needed for new projects I want to deploy using Coze, and for which I need to create brand new plugins… Stay tuned!🚀
Thanks to DEV Community and Coze for the amazing challenge, I really enjoyed it😊!
