oss-slu / DigitalBonesBox

This project is a Web App project aims to convert an existing PowerPoint-based educational tool into an interactive, mobile-friendly web application.
MIT License
0 stars 0 forks source link

Automate content generation #9

Open kate-holdener opened 1 week ago

kate-holdener commented 1 week ago

Looking at the prototypes the team created, I think it would be beneficial to involve the client in creating the content. Rather than the development team specifying the description of different bones, it would be better if the application content was specified in some kind of configuration/text file, and we had a script or some other automation process that reads the configuration/text file and generates the pages.

This would allow to offload the "bones" content generation to the client, while the development team could focus on the technical aspects of the project.

Here are some possible formats the client could use to generate the content.

  1. Structured text

NAVIGATION:

MAIN TITLE: What is the Clavicle?

DESCRIPTION: The clavicle, or collarbone, is a long bone that acts as a strut between the shoulder blade and the sternum. It helps support the shoulder and allows for a wide range of arm movements.

SECTION: Function The clavicle provides stability to the shoulder and assists in the movement of the arm.

SECTION: Key Features

  1. Spreadsheet
    |---------------|-----------------------------------------------------------------------|
    | Page Title    | Clavicle - Detailed Information                                        |
    | Navigation    | Home: index.html, Clavicle: clavicle.html                              |
    | Main Title    | What is the Clavicle?                                                  |
    | Description   | The clavicle, or collarbone, is a long bone that acts as a strut... |
    | Section 1 Title | Function                                                             |
    | Section 1 Content | The clavicle provides stability to the shoulder...                   |
    | Section 2 Title | Key Features                                                         |
    | Section 2 Content | Sternal End, Acromial End, Body                                     |
  2. Markdown

Navigation

What is the Clavicle?

The clavicle, or collarbone, is a long bone that acts as a strut between the shoulder blade and the sternum. It helps support the shoulder and allows for a wide range of arm movements.

Function

The clavicle provides stability to the shoulder and assists in the movement of the arm.

Key Features

It would be useful to discuss these options with the client to figure out his preference, and then create scripts/automation that can integrate client-generated content into the application.