> For the complete documentation index, see [llms.txt](https://bernardo.gitbook.io/development-docs-java/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bernardo.gitbook.io/development-docs-java/master.md).

# Introduction

This is a personal programming guide and code base, to help myself when developing a software project.

It explains the methodologies I use and prefer, how to use them and if possible it explains decisions I took. This way I can keep a knowledge base, instead of going through a process of forgetting and re-learning when retaking an old project.

As it is just a helping tool, it does not aim to be an in-depth guide. It expects a certain grade of knowledge about computer science and software technologies.

## Reading the docs

The docs can be [read in Gitbook](https://bernardo.gitbook.io/development-docs-java/), where they are deployed automatically.

## Building the docs

The docs source is composed of markdown files, meant to be used with [Gitbook](https://www.gitbook.com/).

## Collaborate

Any kind of help with the project will be well received. Any recommendation or tip can be added to the issue management and will be taken into account.

Of course everybody is free to fork and adapt the project for their own use.

### Issues management

Issues are managed at the GitHub [project issues tracker](https://github.com/bernardo-mg/development-docs-java/issues), where any Github user may report bugs or ask for new features.

### Getting the code

If you wish to fork or modify the code, visit the [GitHub project page](https://github.com/bernardo-mg/development-docs-java), where the latest versions are always kept. Check the 'master' branch for the latest release, and the 'develop' for the current, and stable, development version.

## License

The project has been released under the [MIT License](http://www.opensource.org/licenses/mit-license.php).


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://bernardo.gitbook.io/development-docs-java/master.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
