Web Tools DocGuides

How to use Tech Doc Templates

Get the best out of Tech Doc Templates: every option explained, a worked example, and what to check when the output is not what you expected.

Updated July 31, 2026

What it does

Generate markdown templates for RFCs, architecture notes, and API design docs. It runs entirely in your browser — your input never leaves your device.

Options

Every setting this tool exposes, straight from the code that validates it.

OptionTypeDefaultWhat it does
templatetextarchitectureDefaults to architecture.
titletextDocument title. Required.
summarytext
audiencetext
assumptionstextOne assumption per line.
requirementstext
decisionstext
riskstext

Worked example

Run these settings on the tool page:

  • template: architecture
  • title: example

You get:

# example



## Audience
- Engineering team

## Assumptions
- TBD

## Requirements
- TBD

## Architecture Decisions
- TBD

## Risks
- TBD

Getting the result you want

Most of the control here is in the options above. If the output is not what you expected, the setting to check first is template and summary — those change the shape of the output rather than the input it accepts.

Troubleshooting

  • Nothing happens / the output stays empty. title is required — the tool waits until you provide it.
  • It is slow on very large input. Everything runs in your browser, so speed depends on your device. Very large inputs are best split up, or run through the API where the work happens on our servers.

Automating it

The same logic is available as a REST endpoint, so you can run it from a script, a CI job or your own app.

Bash
curl "https://api.toolsxpo.com/v1/tech-doc-templates" \
  -H "Authorization: Bearer $TOOLSXPO_KEY"

It costs 1 credit per successful call. See the full endpoint reference, or try it in the playground.

Tools covered here

Tech Doc Templates

Writing

writing

Related