> For the complete documentation index, see [llms.txt](https://publishers.fairassist.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://publishers.fairassist.org/understanding-the-flowchart.md).
# Understanding the Flowchart
Version of 25 May 2026; CC BY-SA 4.0.
The Flowchart is one of the three main components of the Editorial Reference Handbook.
The Flowchart is available as a [**downloadable visualisation**](https://doi.org/10.17605/OSF.IO/KNQZU) (CC BY-SA 4.0), where each step is also hyperlinked to this specific section in this Guidance page to provide definitions and help with the implementation of the checks.
The arrows in the Flowchart illustrate the path to follow depending on the result of assessing a particular manuscript. This may be to continue with the flowchart or perform a corrective action.
{% hint style="warning" %}
The Flowchart contains 'stop' conditions that say 'Contact Author' and that only occur when a manuscript **Fails** one of the elements. A manuscript is presumed to be compliant with the Handbook if all elements either **Pass** or are **N/A**. If any element fails, your journal should take appropriate action. The action taken is dependent upon the particular internal protocols for your journal. Some examples of corrective action include contacting authors separately upon each failure, or collating all failures and pass them on to the authors for correction through a single communication. The corrective activity undertaken will be specific to your journal guidelines.
{% endhint %}
---
# 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://publishers.fairassist.org/understanding-the-flowchart.md?ask=&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.
