technical-writing

Technical Writing

This skill provides comprehensive guidance for creating clear, effective technical documentation that helps users and developers.

Documentation Structure

The Four Types of Documentation

1. Tutorials (Learning-oriented)

• Goal: Help beginners learn
• Format: Step-by-step lessons
• Example: "Build your first API"

2. How-to Guides (Problem-oriented)

• Goal: Solve specific problems
• Format: Numbered steps
• Example: "How to deploy to production"

3. Reference (Information-oriented)

• Goal: Provide detailed information
• Format: Systematic descriptions
• Example: API reference, configuration options

4. Explanation (Understanding-oriented)

• Goal: Clarify concepts
• Format: Discursive explanations
• Example: Architecture decisions, design patterns

README Structure

# Project Name

Brief description of what the project does (1-2 sentences).

[![Build Status](badge)](link)
[![Coverage](badge)](link)
[![License](badge)](link)

## Features

- Feature 1
- Feature 2
- Feature 3

## Quick Start

```bash
# Installation
npm install project-name

# Usage
npx project-name init

Prerequisites

• Node.js 18+
• PostgreSQL 14+
• Redis 7+

Installation

Using npm

npm install project-name

Using yarn

yarn add project-name

From source

git clone https://github.com/user/project.git
cd project
npm install
npm run build

Configuration

Create a .env file:

DATABASE_URL=postgresql://user:password@localhost:5432/db
API_KEY=your_api_key

Usage

Basic Example

import { createClient } from 'project-name';

const client = createClient({
  apiKey: process.env.API_KEY,
});

const result = await client.doSomething();
console.log(result);

Advanced Example

[More complex example with explanations]

API Reference

See API.md for complete API documentation.

Contributing

See CONTRIBUTING.md for guidelines.

License

MIT © [Author Name]

Support

• Documentation: https://docs.example.com
• Issues: https://github.com/user/project/issues
• Discussions: https://github.com/user/project/discussions