Start here
About this guide
What this guide covers, where you find it, and how to print it.
This is the user guide of the Yavaren™ software. It explains, step by step, how your organisation uses Yavaren: connecting your work tracker and repositories, handing over requirements and stories, approving plans and acceptance criteria, reviewing the draft pull requests that come back, deciding what is waiting for you in the console or in the mobile app, asking Yavaren for services and support, keeping your software up to date, and administering your organisation and your installation.
Where you find it
- In the console: Help opens the help centre, filled in for your organisation (your plan, your trial, what changed). User guide in the help centre opens this guide.
- At
/guideon your installation: the console serves this guide at the address of your installation followed by/guide, for examplehttps://yavaren.example.com/guide. It works on an installation with no connection to the internet: the guide is part of the software and asks nothing from anywhere. - In the installer bundle: the bundle you install from carries the same guide in its
guidefolder. Openguide/index.htmlin a browser before you install. - The installer's last screen links to it once your installation is ready.
Printing it
Printable guide at the top of every page opens the whole guide as one document, one topic per page. Print it, or save it as a PDF from your browser's print dialog. Where the guide was built with a PDF tool, a ready-made PDF is linked next to it.
Which version it describes
Every page names the version of the Yavaren software it was built for, at the top and at the bottom. The guide is built from the same sources as the help centre in the console, so the two say the same things. When you upgrade your installation, the guide is upgraded with it.
A word on names
Yavaren™ is the name of the software and of the services described here. Tulaian is the name of Yavaren's AI delivery engineers. Yavaren is a trademark of WeCan LLC.