Next-Gen Documentation

Transforming Learning Materials Effortless

You can become a driving Force in the new creators economy!!!

Arunima Chaudhuri �(LFX Mentee)

Barbara (Bobbi) Muscara, M.Ed�(Mentor)

Tripur Joshi �(Technical Writer)

Akanksha Rani�(LFX Mentee)

Gianluca (Software Engineer)

Kajal Kumari (Coder & Developer)

AI Trends in Enterprise Documentation

​

​

Hyperledger Documentation Task Force

Agenda�

AI Trends in Enterprise Documentation

​

1. Chat GPT -Arunima
2. Gamma - Kajal
3. Whimsical- Tripur
4. Pictory AI - Akanksha
5. Chat FAQ - Gianluca

​

Final Recommendations

• Library Metaverse -All

Documentation Excellence

Continuous Improvement

Chat GPT -Arunima

Documentation Excellence

Continuous Improvement

Chat GPT Prompts

Documentation Excellence

Continuous Improvement

Gamma - Kajal

Documentation Excellence

Continuous Improvement

Whimsical- Tripur

Documentation Excellence

Continuous Improvement

Pictory AI - Akanksha

Documentation Excellence

Continuous Improvement

Chat FAQ - Gianluca

Documentation Excellence

Continuous Improvement

Library Metaverse -All

Thank You

QNA

Documentation Excellence

Continuous Improvement

Documentation Task Force: Goals

Hyperledger Documentation �

Task Force Leader

• Committee Chair
• Arunima

Documentation Task Force: Objectives�

​

• Interactive and Community-Driven Content�
• Accessible Templates and Style Guides�
• Modular Documentation�
• User Guides for Different Audiences�
• Accessibility�
• Education�

Hyperledger Documentation Task Force

Agenda�

Goals and Objectives� Areas for Recommendations

• GitHub Templates
• Github Make The Docs
• Community Templates
• Best Practices Badges
• User Guides
• Onboarding�

AI Trends in Enterprise Documentation

Final Recommendations

​

Hyperledger Documentation Task Force�

GitHub Templates

GitHub Templates Committee Chair Gianluca

The purpose of this committee is to guide community maintainers and new community maintainers through the process of getting a project through the stages in the project life cycle by providing checklists, templates, and guides.

Hyperledger �Maintainers �GitHub Support

GitHub Requirements

https://labs.hyperledger.org/

The process to propose a new lab

Hyperledger Labs.

Checklist

Dashboards

Hyperledger Documentation Task Force

Agenda�

Goals and Objectives� Areas for Recommendations

• GitHub Templates
• Github Make The Docs
• Community Templates
• Best Practices Badges
• User Guides
• Onboarding�

AI Trends in Enterprise Documentation

Final Recommendations

​

Hyperledger Documentation �

Make The Docs

• GitHub - Make the Docs Committee Chair Tripur
• Create guides for turning your Repos into awesome training manuals for unified documentation.

Make the Docs�(Introduction)

Hyperledger offers premium tools, including Make the Docs, which is remains relatively unknown among Hyperledger community members.

Limited awareness creates challenges for projects seeking documentation solutions.

This knowledge gap leads to a quest for alternative free open-source documentation platforms.

Make the Docs is a valuable resource, but there are alternatives.

Make the Docs [A quick Set-up Guide]

Install Python and Pip

​

• MkDocs requires Python and Pip to be installed.

​

Install MkDocs �

• Use Pip to install MkDocs and its essential dependencies.

​

Install custom themes

​

• With MkDocs, you can install custom themes to take your site to the next level.

​

Configure Site Settings

​

• Before you start writing, you'll configure your site's basic settings in the configuration file like the site name, description, and other options like the navigation.

​

Make the Docs Vs GitBook

• Long Set-up process

​

​

• Simple Login process

​

Set-up

​

​

​

Ease of use

​

​

Collaboration

​

​

Version control

​

​

Analytics

• In-built collaboration tools

​

​

• Easier for non-technical users

​

​

• In-built feature

​

​

• Seamlessly with GitHub

​

​

• Requires GitHub repository

​

​

• Requires technical knowledge

• Doesn’t provide

​

​

• Requires external tools

​

​

A.I. Tool

• Whimsical is an AI-powered diagramming tool. It helps you create diagrams, flowcharts, UML, wireframes, etc in an interactive and visual way.

• It integrates with various tools like Google Docs, Notion, Figma, etc. You can export your diagrams to these tools.

Demo!

A.I. Tool

• Gammal is an AI-powered presentation tool. It helps you create interactive ppts with diagrams, flowcharts, UML, wireframes, etc.

• Allows non-technical users to access AI through an intuitive visual interface. Uses a drag-and-drop flowchart builder.

Demo!

Hyperledger Documentation Task Force

Agenda�

Goals and Objectives� Areas for Recommendations

• GitHub Templates
• Github Make The Docs
• Community Templates
• Best Practices Badges
• User Guides
• Onboarding�

AI Trends in Enterprise Documentation

Final Recommendations

​

Hyperledger Documentation �

Community Templates

• Templates Kajal
• Simplify the use of templates within the Hyperledger community, ensuring that documentation creation is streamlined and unified.

Community Templates

What does templates community do?

• Create new templates: Researching on various templates that will be used for website documentation. The templates will be made considering the various project needs. Identifying various template projects will be needed.
• Review older templates and update the new guidelines and logo in them. Redesigning the existing templates for a better onboarding experience.
• There are various project checklist (templates by purpose) which we will take consider while working on the templates.

Revolutionising the documentation with awesome AI tools:

1. ChatGPT, Dall E2
2. Figjam and JamBot
3. Looka.com
4. Clipdrop and many more..

Problems and Opportunities

on Existing Templates

​

Templates available:

1. White Paper Standards
2. Use cases
3. Blog Basics
4. GitHub Basics: User guides and GitHub resource pages
5. Presentations
6. Graphic Set Standards

Research Case Study: Link

Jambot: Figma’s revolutionary AI tool

​

Figma, the renowned collaborative design platform, has achieved a significant milestone with the introduction of Jambot, an AI-powered design tool. Jambot represents a significant advancement for Figma, as it offers the potential to enhance various aspects of the platform.

Demo Link: Link

Hyperledger Documentation Task Force

Agenda�

Goals and Objectives� Areas for Recommendations

• GitHub Templates
• Github Make The Docs
• Community Templates
• Best Practices Badges
• User Guides
• Onboarding�

AI Trends in Enterprise Documentation

Final Recommendations

​

Hyperledger Documentation �Development Guide

​

Best Practices

• Badge Builder
• Badge Builder to integrate badging and tokenization seamlessly into the broader Hyperledger ecosystem..

Best Practice Guidelines

Documentation Badging

• Gain Badges for documentation creation
• Once Documentation badge is earned for that stage in the life cycle, advancement is possible.

Community Dashboards

Purpose :

• Describe dashboards to aid the community by persona.

Persona :

1. Maintainers Dashboard
2. Contributor Dashboard
3. Community Member
4. Community Curious

Create 4

sections

Per persona

Maintainers

Dashboard

Contributors Dashboard

Community

Members

Community

Curious

Hyperledger Documentation Task Force

Agenda�

Goals and Objectives� Areas for Recommendations

• GitHub Templates
• Github Make The Docs
• Community Templates
• Best Practices Badges
• User Guides
• Onboarding�

AI Trends in Enterprise Documentation

Final Recommendations

​

Hyperledger Documentation �

Community User Guides – Creation and Accessibility

• Metaverse Content Creation Hub and Dashboards
• To provide tools to craft comprehensive and easy-to-understand community user guides.

Content Creation Dashboards for User Guides

Learnworld features and functionalities demonstrate how content creation dashboards can be seamlessly integrated into Hyperledger Community workflow.

​

​

​

Hyperledger Documentation Task Force

Agenda�

Goals and Objectives� Areas for Recommendations

• GitHub Templates
• Github Make The Docs
• Community Templates
• Best Practices Badges
• User Guides
• Onboarding�

AI Trends in Enterprise Documentation

Final Recommendations

​

Hyperledger Documentation Task Force

Agenda�

Goals and Objectives� Areas for Recommendations

• GitHub Templates
• Github Make The Docs
• Community Templates
• Best Practices Badges
• User Guides
• Onboarding�

AI Trends in Enterprise Documentation

Final Recommendations

​

Community Documentation -AI powered User Guides

COURSE PLANNER�AI powered tools to assist in generating course outlines and learning activities

EBOOK WRITER�AI Crafted comprehensive ebooks to systematically develop learning tracks to convey knowledge effectively to designated audiences

ASSESSMENT DESIGNER�Swiftly create diverse precise assessments with AI efficiency and accuracy,�

LEARNING TOKENS

Reward learners with Learning Tokens for educational bonuses

FEEDBACK GENERATOR�Deliver constructive and personalized feedback promptly (no pun intended)

EMAIL CREATOR�Engage learners with AI enhanced impactful emails fostering motivation.

CONTENT EDITOR�Elevate content quality with AI-polished text ensuring clarity and consistency.q

AI Tool FAQ - Gianluca

Open Source AI tool: Proof-of-Concept

Gianluca Capuzzi

Goal: implement a proof-of-concept

Technology: Transformers

Main applications in Natural Language Processing:

• Text Classification (sentiment analysis of user’s reviews)
• Text Translation
• Text Generation (from a sentence to a paragraph)
• Text Summarization (from a paragraph to a sentence)
• Question Answering
• Combinations of previous applications

Architecture of XLM-R (based on BERT)

560M parameters

SQuAD dataset

100.000 questions and answers sampling English articles from Wikipedia

Transfer learning: “To give you a sense of the difference between fine-tuning and training a model, fine-tuning is like taking your car to the mechanic and getting new spark plugs whereas training/pre-training is like getting a whole new engine.”

Fine tuning using Hyperledger documentation (domain adaptation)

Retriever-Reader QA architecture

Extractive QA

Demo

Future improvements

Present the outcome of the project

whitepaper

blog article (medium.com)

linkedin post

github repository

documentation (requirements, installation, usage, …)

model share on hugging face

Hyperledger Documentation Task Force

Agenda�

Goals and Objectives� Areas for Recommendations

• GitHub Templates
• Github Make The Docs
• Community Templates
• Best Practices Badges
• User Guides
• Onboarding�

AI Trends in Enterprise Documentation

Final Recommendations

​

Recommendations

1. Create a Taskforce For Enterprise AI
2. Checklist, Dashboards and Consistent User Guides for the Community
3. Create a Content Creation Hub
4. Create a Lab for FAQ AI
5. Create a Taskforce For the Hyperledger Foundation Library (Metaverse)

ETHindia 2023

ETHGlobal https://ethglobal.com/

Hyperledger Metaverse Library

Thank You

QNA