Шаблон документации пакета

Как использовать

Скопируйте этот файл, переименуйте и заполните секции. Удалите инструкции в блоках :::info.

---

Обзор

{package-name} предоставляет:

Инструкция

Опишите основные возможности пакета. Что он делает? Какую проблему решает?

Установка

npm install {package-name}

Peer dependencies:

{
	"{peer-dep-1}": "^x.x.x",
	"{peer-dep-2}": "^x.x.x"
}

Инструкция

Укажите команду установки и peer dependencies если есть.

Быстрый старт

import { {Export} } from '{package-name}';

// Минимальный пример использования
const result = {Export}();

Инструкция

Покажите минимальный рабочий пример.

API Reference

Сигнатура:

function {functionName}(params: I{Params}): {ReturnType}

Параметры:

Параметр	Тип	Обязательный	Описание
{param1}	string	Да
{param2}	number	Нет

Возвращает: {ReturnType} —

Пример:

const result = {functionName}({
	{param1}: 'value',
	{param2}: 42
});

Инструкция

Документируйте каждую публичную функцию/класс/метод.

---

Конструктор:

new {ClassName}(options: I{Options})

Опции:

Опция	Тип	По умолчанию	Описание
{option1}	string	undefined
{option2}	boolean	true

Методы:

.{methodName}()

instance.{methodName}(arg: string): void

Инструкция

Документируйте классы с их конструкторами и методами.

---

Интерфейсы

I

interface I{InterfaceName} {
	{field1}: string;
	{field2}?: number;
	{field3}: boolean;
}

Поле	Тип	Описание
{field1}	string
{field2}	number	{Описание} (опционально)
{field3}	boolean

Инструкция

Документируйте все публичные интерфейсы.

Примеры использования

Пример 1:

import { {Export} } from '{package-name}';

// Полный рабочий пример
{Код примера}

Пример 2:

{Код примера}

Инструкция

Добавьте реальные примеры использования для разных сценариев.

Конфигурация

Переменные окружения

Переменная	Описание	По умолчанию
{VAR_NAME}		{default}

Файл конфигурации

// {config-file}.ts
export const config = {
	{option1}: 'value',
	{option2}: true
};

Инструкция

Если пакет имеет конфигурацию — опишите её.

Интеграция с Angular

Провайдеры

// app.config.ts
import { provide{Name} } from '{package-name}';

export const appConfig: ApplicationConfig = {
	providers: [
		provide{Name}({
			{option}: 'value'
		})
	]
};

Использование в компонентах

@Component({...})
export class MyComponent {
	private readonly {service} = inject({Service});
}

Инструкция

Если пакет предназначен для Angular — покажите интеграцию.

Тестирование

Unit тесты

import { {Export} } from '{package-name}';

describe('{Export}', () => {
	it('should {описание теста}', () => {
		const result = {Export}({params});
		expect(result).toBe({expected});
	});
});

Моки

// Мок для тестирования
const mock{Name} = {
	{method}: jest.fn()
};

Инструкция

Покажите как тестировать код, использующий пакет.

Миграция

С версии X.X на Y.Y

Breaking changes:

Как мигрировать:

// Было
{
	oldCode;
}

// Стало
{
	newCode;
}

Инструкция

При мажорных обновлениях добавляйте инструкции по миграции.

Troubleshooting

Симптом:

Решение:

{Код решения}

Частые ошибки

Ошибка	Причина	Решение
{ErrorType}

Инструкция

Добавьте типичные проблемы и их решения.

Производительность

Рекомендации

Benchmarks

Операция	Время	Память
{operation}

Инструкция

Если важна производительность — добавьте рекомендации и бенчмарки.

Changelog

Версия	Дата	Изменения
1.1.0
1.0.0		Начальная версия

Инструкция

Ведите историю изменений пакета.

Содействие

Как внести изменения

1. Fork репозитория
2. Создайте ветку: git checkout -b feature/my-feature
3. Внесите изменения
4. Запустите тесты: npm test
5. Создайте PR

Стиль кода

Следуйте правилам кода проекта.

Инструкция

Добавьте инструкции для контрибьюторов.

Лицензия

Следующие шаги

• Зависимости проекта

Инструкция

Добавьте ссылки на связанную документацию.

---

Удалите перед публикацией

Удалите все блоки ::: info Инструкция перед публикацией документации.