ollama - 💡(How to fix) Fix Documentation best practice for Modelfile system prompts — HADS standard [3 comments, 2 participants]

Fix Plan

To implement the HADS standard in Ollama documentation, follow these steps:

• Update the documentation template to include the AI manifest at the top
• Use the following tags to section the documentation:
  • **[SPEC]** for facts to extract
  • **[NOTE]** for human context
  • **[BUG]** for known failures and fixes
• Ensure the tags are used consistently throughout the documentation

Example code snippet:

# AI Manifest
This document follows the Human-AI Document Standard (HADS)

## Introduction
**[NOTE]** This is a human-readable introduction to the system

## System Specifications
**[SPEC]**
* Fact 1
* Fact 2
* Fact 3

## Known Issues
**[BUG]**
* Issue 1: description and fix
* Issue 2: description and fix

Verification

To verify that the fix worked, check that the documentation is correctly sectioned with the HADS tags and that the AI model is able to extract the relevant information.

Extra Tips

• Use a linter or automated tool to enforce consistent use of the HADS tags
• Provide guidance to documentation authors on how to use the HADS standard effectively
• Consider adding a link to the HADS specification in the Ollama documentation for reference.