Bolstering Augment Code Outcomes

I wanted to provide a simple guide for users of Augment Code (AC), based on my own successes using this incredible extension in Visual Studio Code. AC has been really great for my AI-enabled software development projects, playing a critical role in my most recent offering focalchat.com.

There are many more, much better sophisticaed ways of fine-tuning AC with instructions but I wanted to put a guide together for newcomers and advanced developers alike who have just adopted AC to their coding activities. This guide is meant as a starting point, thus.

First up, User Guidelines. In here we can add in specific instructions to AC on startup and we'll use it to create some baseline files that AC will refer to for assistance. Think of it as generating a map of key locations in your code for AC to be able to read up on. Like all AI's in software development, AC can wander no matter how much it tries not to! So if we can reduce those drifts, we should.

You'll find User Guidelines here in the UI:

Click on User Guidelines to enter these key instructions for Augment Code to follow.

I would encourage you to try your own Guidelines, see what is best for you, but here are mine to get you started:

Again, you don't have to use APP_MAP.md and DB_INFO.md, it's just what I use. Also think about other files you want AC to use as it goes. It could be anything you need to store in a markdown (md) file that provides instructions. It's a good idea to check on these files (which tend to be stored in root directory but you can have them saved to a docs directory if you wish, just state that in the User Guidelines) to make sure they are being generated. If they are not, trigger them with a couple of prompts AT THE BEGINNING of your project, before starting any coding activity: (For APP_MAP.md as an example) "We will use a file, stored in the docs directory of this project, called APP_MAP.md. You will detail the progress we make in the project, keeping it updated at all times. Tick off new functions and when we plan but don't execute code, set them as future objectives. Any major fixes we make, also detail them in this file. Start updating the file after each new file/function/process we create from now on and keep it updated religiously. (For DB_INFO.md if your app will likely need a database, as an example)

"We will use a file, stored in the docs directory of this project, for ALL database functionality needs, called DB_INFO.md. Ensure that you have stored detailed information on database schemas here so you don't have to keep executing SQL commands aimlessly. Use this as your reference guide. Also update it as we change the database (if we do) so your understanding remains up to date. Create this file now and start updating the file every time we execute database-related updates, changes and more. It MUST remain up to date. From time to time, you may STILL see Augment Code (and many other AI extensions) drift, so don' be afraid to say at any time in the usual chat window/area you'd ask for code in: "REMEMBER: You have the docs directory, and two files that can help you - refer to them to help you!" This tends to be enough to trigger memory (especially in AC) to resume scanning the two files for clues to expedite its activities.

Why do this?

• Reduce token burn. Instead of multiple requests say to resolve functionality issues, it has a strong starting point in the two files to get the task down with minimal calls to the AI.

• More clarity on how the project is progressing. Take time to scan through the two files (or others you may create) to stay on top of your project.

• Consistency - AC will use these files to also enforce stuff for/to itself you don't even ask for, but are critical to your app staying on track and on course.

Augment Code is already great, but with these addtional features, you may well find you are getitng through projects you start quicker and with great documentation to boot :)

Good luck folks!

Jim C June 2025