> For the complete documentation index, see [llms.txt](https://docs.scribeware.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.scribeware.com/customizations/template-customization/building-links-for-instant-comments.md).

# Building Links for Instant-Comments

There are several ways to build Instant-Comments into ScribeWare.

<mark style="color:red;">\*\*\*🚩These are template changes, so be sure you are working in your template and hit Save Template when done to keep these for the next time.</mark>

### #1 Shows the easy way to link a narrative to a field

{% embed url="<https://youtu.be/7JWVxhfj7OA>" %}

### #2 Shows connecting a narrative to a check box using the <mark style="color:blue;">Keyword Connection</mark>

{% embed url="<https://youtu.be/zufHOG28Isw>" %}

### #3 Shows linking a narrative to a check box using <mark style="color:blue;">Suggested Observations.</mark>

The only difference between this version and the one above is that we are using the Suggested Observations method for linking.

{% embed url="<https://youtu.be/w7nJ83lOu3U>" %}

### #4 Linking a narrative to an inspector-only note so that the check box stays hidden but the narrative displays in the report.

Either the <mark style="color:blue;">Keyword Connection</mark> or the <mark style="color:blue;">Suggested Observation</mark> method will work with this method.

🗝️ In this instance, the check box will stay hidden in the finished report, but the narrative will display. This is a great way to build in quick shortcuts to commonly used narratives without cluttering your report with check boxes.

{% embed url="<https://youtu.be/ayOxYS2TuiU>" %}

### #5 Modifying a Narrative to Fit a Number of Different Check Box Deficiencies

{% embed url="<https://youtu.be/eXfcDZ_KW0w>" %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.scribeware.com/customizations/template-customization/building-links-for-instant-comments.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
