Script Valley
Writing Technical Documentation
Writing Tutorials and How-To GuidesLesson 4.3

Writing how-to guides that solve one problem completely

how-to guide structure, problem statement, solution steps, decision points, troubleshooting section, related guides linking, guide scope

How-To Guide Structure

How-To Guide Structure

A how-to guide answers one question: how do I accomplish X? It starts with the assumption that the reader is competent but has a specific problem to solve. No teaching. No explanation unless critical to the task.

Structure

## How to Configure HTTPS on an Express.js App

### What you need
- An Express.js app running locally
- Node.js >= 18.0.0
- A TLS certificate and key file

### Steps

1. Install the `https` module (built into Node.js — no installation needed)
2. Load your certificate and key:

```javascript
const https = require('https');
const fs = require('fs');

const options = {
  key: fs.readFileSync('server.key'),
  cert: fs.readFileSync('server.cert'),
};
```

3. Pass your Express app to `https.createServer`:

```javascript
https.createServer(options, app).listen(443, () => {
  console.log('HTTPS server running on port 443');
});
```

Troubleshooting Section

Add a troubleshooting section for the top 3 failure modes. Format each as: symptom → cause → fix. Never write a how-to without one — real-world setups deviate from ideal conditions.

Linking

End with 2–3 links to related guides. Readers completing one task often need the next one.

Up next

How to write clear step-by-step instructions

Sign in to track progress