---
# System prepended metadata

title: План курса "Техническая документация"

---


# План курса "Техническая документация"

*[MD]: MarkDown, облегченный язык разметки, созданный с целью форматирования текста в упрощенном виде, поддерживаетHTMLоблегчения 
*[Swagger]: MarkDown, облегченный язык разметки, созданный с целью форматирования текста в упрощенном виде, поддерживаетHTMLоблегчения 
*[SC]: shortсut, сокращение в сервисах и программах  
*[HK]: Hot key, "Горячая клавиша"
*[Гомер]: Гомер Симпсон, персонаж одноименного мультфильма.
*[Ридер]: Писатель документации, автор. 

Концепт курса "Техническая документация". 
По моему смыслу, основная цель: Научить людей вести документацию проекта, писать статьи и грамотно излагать мысли по решению тех или иных проблем.   
## Задачи курса 
1) Объяснить, почему программисты любят писать статьи, документации 
2) Рассказать, почему важно писать техническую документацию на примере жизненного опыта 
3) Какие плюсы можно получить от команды/компании за ведение своей документации. 
4) Как правильно будет вести документацию, разбивать на разделы, выделять текста 
5) Познакомить студента с MD языком 
6) Познакомить с инструментами написания тех документации

## Главы курса 


### Вводная часть
Истории из жизни, мотивация писать доки, статьи. Краткая информация о плюшках. 
* Привет, я технический писатель
* Как я спустил в унитаз 4 месяца работы 
* Моя продуктивность выросла в 3 раза с  тех пор, как стал писать статьи 
* Получил лучший оффер в команде из-за того, что умею в MD
* Почему тебе захочется писать на хабре 
[Описание главы](###Описание-вводной-части)
### Основа 
Главное, что должны уметь студенты для написания документации
* Ты не умеешь писать концепты и вот прочему 
* Мышление программиста через MD 
* Программисты не используют мышку 
* магия языка MD, или почему тебе не нужен Microsoft OFFICE 
* MD для юнлингов 
* пиши доки как магистр 
* Фишки языка MD, которые упростят тебе жизнь 
* Что нужно еще знать, что бы проникнуться тех писательством? 
* Что такое swagger и почему повторение - страшный грех программиста
* Топ сервисов для ленивых писателей
[Описание главы](###Основная-часть)

### Дополнительная информация
Передача личного опыта, что бы студены не совершали глупые ошибки 
* интеграция сервисов для ленивых людей Думай, что твой текст читает Гомер
 Не думай, что оптимизировать можно только рабочий код
* Фишки редакторов за 300. 

## Краткая информация глав 
Краткая выжимка, о чем хотел бы тут рассказать и почему я считаю это важным 
### Описание вводной части 
Главный смысл этой части, **замотивировать** студента курса, рассказать, какие плюшки можно получить за тех доки, какие привилегии получает Ридер.
 
 #### Привет, я Технический писатель. 
 Цель:  Познакомить студента с тем, кто такой технический писатель, чем он отличается от классического писателя. Почему "Программист-Ридер"  цениться больше, чем просто программист. 
#### Как я спустил в унитаз 4 месяца работы
цель: Рассказать негативный опыт ведения проекта, где не было  тех документации, что произошло с ним и почему я потерял на этом деньги. 

#### Моя продуктивность выросла в 3 раза с  тех пор, как стал писать статьи
Цель: Поведать плюсы, которые ждут людей, после написания документаций и статей.  
#### Получил лучший оффер в команде из-за того, что умею в MD
Цель: Рассказать привилегии, которые получают ридеры в команде.  
#### Почему тебе захочется писать на хабре 
Цель: Познакомить с хабром и причинами, почему стоит туда писать статьи 

### Основная часть 
Цель: Научить писать документацию, статьи. Рассказать про шаблоны доков. Познакомить с MD, Swagger.
#### Ты не умеешь писать концепты и вот прочему
Цель : Рассказать, что конспекты надо писать исходя из работы, а не писать вовремя работы.  
#### Мышление разработчика через MD
Цель: Азы тех доков, запросы, UI/ UX описание, таблицы и диаграммы. 
#### Программисты не используют мышку 
Цель: Ускорить скорость печати, рассказать про SC/HK  
#### магия языка MD, или почему тебе не нужен Microsoft OFFICE 
Цель: Познакомить студентов с языком разметки MD 
#### MD для юнлингов 
Цель: Научить использовать MD ( аля Junior MarkDown ) 
#### пиши доки как магистр 
Цель: Показать задачи на MD, таблицы, диаграммы, ссылки и шаблоны кода. 
#### Фишки языка MD, которые упростят тебе жизнь 
Цель: Показать фишки в формате trick&tips в MD  
#### Что нужно еще знать, что бы проникнуться тех писательством? 
Цель: Задачи на практику в MD на примерах игр, книг, составление хронологии
#### Что такое swagger и почему повторение - страшный грех программиста
Цель: Работа с автодоками, ссылками на них  и исправление повторений. 
#### Топ сервисов для ленивых писателей
Цель: Сервисы, которыми я пользуюсь для ускорения написания. 
### Дополнительная информация
Цель: Передать опыт написания тех доков и tд.
 интеграция сервисов для ленивых людей 
*
Цель: Рассказать, какие сервисы и их альтернативы помогают при тех доках или статей  
####  Дать понимание, что студент должен писать код для "тупых" людей, ведь время от времени тупые все. 
#### Не думай, что оптимизировать можно только рабочий код
Цель : Оптимизация процессов написания тех доков. 

```mermaid
flowchart TB
n1(Завоевывание доверия)
n2(Мотивация)
n3(Примеры удачные) 
n4(Обучение) 
n5(оддерживание студента морально)
n6(оощерение за проделанную работу ) 
n7(Передышка) 

n1-->n3-->n2-->n4-->n5
-->n6-->n7-->n4

```
