Evaluating documentation

Understanding documentation evaluations and how to request them

Documentation, like that of open source and private packages, in the registry show evaluation scores that tell you whether that documentation actually improves agent code quality.

TL;DR

Documentation provides information on how to use open source or private libraries.

By publishing a tile with documentation for an open source or private library, an evaluation will be performed to determine how effective the documentation is. For example:

• The Tessl registry has documentation for [email protected], the evaluation will determine how well tasks are performed by an agent with and without the v5.1.0 Tessl tile.

What evaluations measure

Evaluations test agents on real tasks with and without documentation:

• Does the agent use correct APIs?

• Does the agent follow best practices?

• Is the code maintainable?

For example: Without docs, an agent might use http.createServer() directly. With good docs, it uses Express's app.listen() - the intended API.

Viewing evaluation results

In the Tessl Registry, evaluation results show:

• How much a tile improves agent accuracy

• Which tasks it helps with

• Whether it's worth installing for your use case

Use these scores to choose tiles that will actually help your team.

Requesting evaluations

Need documentation for a public package that doesn't have coverage yet?

1. Visit the Tessl Registry

2. Request an evaluation for that package

Creating evaluated tiles

When you create and publish documentation, they can be evaluated:

# Create documentation
tessl tile new --name myworkspace/my-library-docs --docs

# Write your documentation
# Edit docs/index.md with structured guides

# Publish
tessl tile publish

Published tiles are evaluated to show their impact on agent accuracy.

Next steps

• Evaluating skills - Skill evaluation scores

• Creating documentation - Write tiles

• Autogenerating documentation - Generate docs

Related

• Blog: How documentation improves agent accuracy

• Tessl Registry - Browse evaluated tiles

• Glossary: Evaluations