Generated Content Structure

Overview

In addition to telling Driver what content you want it to generate from your Smart Instruction prompts, you can optionally include a description of how you want that content structured. This includes support for paragraphs, tables, lists, diagrams, and code blocks.

Below are some examples of how you can specify the content structure directly in your Smart Instruction prompts.

One important thing to keep in mind is that there is no special syntax or convention to follow when calling out the content structure you want. Simply describe what you expect to see and Driver will do the rest.

Unspecified

Write a smart instruction prompt without specifying any details about the expected structure of the generated content.

Specifying the content structure is optional. If you omit a description of the desired structure, Driver will decide for you based on the nature of the prompt and references.

Paragraph

Specify that you want the generated content in the form of a paragraph.

You may notice that when left unspecified, Driver may generate content with a rich structure and combination of formatting options. At times, it can be helpful to avoid this structure and constrain the output to a paragraph or two. Feel free to request a single paragraph or a specific number or leave it open-ended.

Table

1. Specify that you want the generated content in the form of a table.
   
   

   

   
   

2. Optionally list and describe the expected columns
   
   

   

Tables are a great way to display a lot of similar information in a way that is easy to digest visually. You can tell Driver exactly what you want to see in the table columns or let it choose for you. If you specify the columns to show in the table, Driver can typically infer what information the columns should include. For more control, you can also describe each column in addition to specifying the names.

Diagram

Sequence Diagram

1. Specify that you want the generated content in the form of a sequence diagram.
   
   

   

   
   When requesting a diagram, Driver actually generates a code block with Mermaid JS code that describes the diagram. By default, the code block will be in "Split" mode, showing this code and a preview of the diagram.
   

2. Select "Preview" from the drop-down menu to show only the diagram.
   
   

   

   
   

   

Block Diagram

Specify that you want the generated content in the form of a block diagram.

Beyond block and sequence diagrams, explore creating flow charts, class diagrams, and state diagrams to visually describe important concepts in your codebase. Also note that you are free to manually edit the Mermaid JS code that Driver generates. The Mermaid JS syntax is documented here: https://mermaid.js.org/intro/syntax-reference.html

Lists

Ordered List

Specify that you want the generated content in the form of an ordered list.

Single Level, Unordered List

Specify that you want the generated content in the form of an un-ordered list.

Multi-level List

Specify that you want the generated content in the form of a two-level list.

Experiment with different combinations of list options and types beyond the examples shown above or simply ask for a list and let Driver determine the structure for you.

Code Block

Specify that you want the generated content in the form of a code block.