- Email
: tripurjoshi3121@gmail.com
- The chair of GitHub
...
- Make the
...
- Docs
- PartAI Task Force
1) PPT - https://docs.google.com/presentation/d/1iFc-aQVHuJJ0IKxvqfL9TVFRIwB4zoAb/edit?usp=sharing&ouid=112303758644562594590&rtpof=true&sd=true
2) GitBook (User Documentation Standard) - https://app.gitbook.com/invite/YiKRvybeEwfBWjowWoek/C3R7Xr7r5FM1n4qElKBK
-
AI Task Force
...
- 1. Harnessing the Power of AI (Revolutionizing Documentation in the Hyperledger Task Force)
2. AI and Hyperledger: A Match Made in Blockchain Heaven (Exploring the Synergy Between Artificial Intelligence and Hyperledger)
3. AI & Hyperledger (AI in the Documentation Task Force)
Introducing "Making the Docs" to Mentees:
Title: Elevating Your Documentation Craft: Unveiling the Power of "Make the Docs"
...
Empower User Understanding: Think of Consider documentation as a bridge between complex technical concepts and your users. When you effectively "Make the Docs," you 're building build a sturdy bridge that connects connecting these two worlds seamlessly, empowering users to grasp intricate details effortlessly.
Enhance User Experience: Documentation isn't just about conveying information; it's about crafting an experience. "Making the Docs" involves creating content that is accurate, easily digestible, intuitive to navigate, and visually appealing. By doing so, you're ensuring users have a positive and productive interaction with your documentation.
Build Trust and Credibility: A well-made document reflects your expertise and dedication as a technical writer. Users are more likely to trust information presented in a clear, organized, and polishedly. This trust enhances your reputation and establishes credibility for both you and your organization.
...
Crystal Clear Clarity: Complexity can be daunting. Break down intricate concepts into bite-sized pieces. Use clear language, avoid jargon, and provide real-world examples to illustrate abstract ideas.
Structured Your Story: Imagine your documentation as a story, with a beginning, middle, and end. Introduce topics, explain concepts step by step, and conclude with a meaningful takeaway. This approach helps users navigate your documentation effortlessly.
Visual Symphony: Incorporate visuals to enhance comprehension. A picture is worth a thousand words, and a well-placed diagram or screenshot can illuminate a concept better than paragraphs of text.
User-First Approach: Anticipate user needs and questions. Develop content that proactively addresses common queries, challenges, and pain points. By doing so, you're providing more than just answers—you're offering solutions.
Consistency and Style: Maintain a consistent tone, style, and formatting across your documentation. Consistency fosters familiarity and makes it easier for users to locate information.
Feedback Loop: Encourage user feedback and iterate on your documentation. This loop helps you identify pain points, clarify ambiguities, and continuously improve your content.
...
So, let's embrace this approach, infuse your documentation with life, and watch as your work leaves a trail of informed and delighted users. The journey of "Making the Docs" begins now, and the possibilities are limitless!
...
...
Notes of meeting 25 July 2023
- Make a presentation on integrating AI in Hyperledger workflow.
User Documentation Improvements needed (for Solang)(I will add more points. Work in progress!
)
...
- Installing Solang:
Remark - The installing section is not beginner-friendly. It is challenging for a user who wants to try it out and learn about it. The first step of setting up should be easy, not overwhelming.
Improvement suggestion - 1. Redesigning the section and making it more simple.
2. Adding screenshots for specific devices.
3. The language used is using too many technical terms without any explanation about them, we can define them and make it more noob-friendly.
...