Handover to IP - Update user documentation

[tubamos]

Item type

documentation

Description

The admin-, end- user documentation

This feature is part of the previous user documentation. It update the user documentation to accurately reflect the current features and functionalities of the software. This includes revising existing content, adding new sections for recent features, providing detailed instructions, incorporating screenshots and diagrams, and including troubleshooting tips and FAQs. The goal is to ensure that the admin / entrepreuner user and end-users have clear, comprehensive, and user-friendly documentation for using the software effectively.

The IP has provided a document with specific requirements related to the admin (entrepreneur) user. Here is the current content (as of writing this backlog item).

How to setup a new AiLixir Agent project

In order to explore a new domain with a AiLixir agent the following steps should be followed:
Fork the complete codebase
Adjust project configuration
…
…
Adjust project/build configuration
API keys…
…
Create new AstraDB instance
…
…
Create new FireBase DB?
Create new Expo project
…
…
Create new Google Doc with base prompt
Change base prompt URL to the new GD
…

How to delete all content in a AstraDB instance
May be delete and create?

How to create and use a new vectorDB (AstraDB) instance
Create
Change config/code to use new DB (which files/format)

How to delete all content in a FireBase DB instance
May be delete and create?

How to create and use a new FireBase DB instance
Create
Change config/code to use new DB (which files/format)

How to run whole data acquisition pipeline

How to only run the scraper part of the data acquisition pipeline

How to only run the population of the vectorDB for all scraped content

How to run the orchestration incrementally

How to look at what content was scraped and pushed into vector DB

For an up-to-date version of the IP requirements for the user documentation please visit the following link:

https://docs.google.com/document/d/1zKfHiJIG38MeqXcFw3gBvszC0Tqfzn6muBvjk4GQW5Q/edit?usp=sharing

User Story

As a software development team,
we need to update the user documentation
to ensure it accurately reflects the current features and functionalities of the project, providing the enterpreuner user and end-users with clear and comprehensive instructions for using the software.

Acceptance Criteria

• All existing user documentation is reviewed and updated to reflect the current features and functionalities of the project.

• New documentation is created for any new features or functionalities added since the last update.

• Step-by-step instructions are provided for all major tasks and workflows within the software.

• Screenshots, diagrams, and examples are included to enhance understanding.

• Each feature of the software is thoroughly documented, including its purpose, usage, and any special considerations.

• Separate section is created for both common user and entrepreneur user in the user documentation

• Entrepreneur user and common user issues and their solutions are documented in a troubleshooting section

• Finalize user, (technical) design, and build/deploy documentation

• Create PDFs for the documentation and upload to Deliverables folder

  • Name and upload files to sprint-12/design/documentation.pdf
  • Name and upload files to sprint-12/build/documentation.pdf
  • Name and upload files to sprint-12/user/documentation.pdf

Definition of Done

• The feature has been fully implemented.
• The feature code is documented with clear explanations of its functionality and usage.
• The feature code has been reviewed and approved by at least one team member.
• The feature branches have been merged into the main branch and closed.
• The feature utility, function and usage have been documented in the respective project wiki on github.