Анна Мария Попова (Х5 Tech) – Фантастический техпис: может ли опыт создания художественных книг помочь в написании документации

Transcript

1. ФАНТАСТИЧЕСКИЙ ТЕХПИС или как опыт создания художественных книг помогает в написании документации
2. ФАНТАСТИЧЕСКИЙ ТЕХПИС или как опыт создания художественных книг помогает в написании документации
3. Два сапога НЕ пара • Многостильность • Средства выразительности • Повествование от 1 или 3 л. • Композиция и сюжет • Цель – развлечь, вызвать эмоции • Простой, разговорный стиль • Без «украшений» • Обращение на «вы» • Продуманная структура • Цель – принести пользу, решить проблему
4.  Пишет произведения в разных литературных жанрах: • рассказ • сказка • роман и др.  Пишет книги в разных жанрах: • фантастика • детективы • исторические романы и др.  Занимается созданием личного бренда и его продвижением  Пишет разные виды документации: • инструкции • FAQ • описание сервиса • описание API  Пишет тексты для чат-ботов  Помогает поддержке в написании скриптов  Помогает дизайнерам в написании текстов для интерфейсов  Актуализирует уже существующую документацию Техпис Писатель
5. Корень зла — в ожиданиях  жанр: • фантастика • детективы • исторические романы и др.  образы героев  сюжет и др. Целевая аудитория определяет:  вид доки: • инструкции • FAQ • интерфейсные тексты  степень детализации описания  наличие терминов и др.
6. Писатель разрабатывает концепцию творчества, например в моих книгах: • переплетаются научная фантастика и фэнтези • вымышленный мир проработан до мельчайших деталей • в сюжете – тайны и интриги, а также моменты, когда герой принимает решение сделать нечто невероятное и изменить ход истории • герой обладает сверхспособностями, но перед героиней оказывается безоружным Путеводный маяк Техпис продумывает концепцию документа: • что пользователь может уже знать о продукте • с какими трудностями он столкнётся на разных этапах • как помочь ему не только преодолеть эти трудности, но и получить удовольствие от продукта
7. Архитектура текста Писатель продумывает, сколько будет книг в цикле, распределяет между ними сюжетные линии, определяет конфликтные узлы Техпис разрабатывает список разделов, распределяет информацию между ними, определяет структурные связи
8. С глазу на глаз Техпис встречается с: • экспертами в предметной области • службой поддержки Писатель представляет свою книгу, как персонажа, и решает: • каким будет характер, т. е. эстетика истории • как книга сможет влюбить в себя читателей • когда идея раскроется на все 100
9. Глубокое погружение Писатель разрабатывает: • физические законы вымышленного мира • народы и их традиции • судьбы героев Техпис знакомится с сервисом: • изучает документы • работает на тестовом стенде
10. Мозговой штурм Писатель выдумывает сюжет, а потом просчитывает его с математической точностью Техпис собирает весь материал, а потом структурирует по заранее подготовленному плану
11. Подготовительные работы Писатель решает: • какую эмоцию испытает читатель • какой фрагмент сюжета будет раскрыт • какие идеи воплотятся в тексте Техпис определяет, какой фрагмент материала будет описан в разделе или на странице
12. Прокрастина..
13. Рабочие чертежи И писатель и техпис, ни на что не отвлекаясь, пишут строчку за строчкой
14. Рабочие чертежи И писатель и техпис, ни на что не отвлекаясь, пишут строчку за строчкой Победа! ЦЕЛЬ ДОСТИГНУТА Время отдыха ТЕПЕРЬ МОЖНО ПОНЕЖИТЬСЯ НА СОЛНЫШКЕ
15. Рабочие чертежи И писатель и техпис, ни на что не отвлекаясь, пишут строчку за строчкой Победа! ЦЕЛЬ ДОСТИГНУТА Время отдыха ТЕПЕРЬ МОЖНО ПОНЕЖИТЬСЯ НА СОЛНЫШКЕ
16. Вычитка и точка o Избавиться от очепяток опечаток o Проверить фактический материал Редактура o Избавиться от штампов o Удалить лишние: • слова • предложения • абзацы Корректура
17. А вот и не конец
18. Тернистый путь 1. Определиться с ЦА и жанром 2. Разработать концепцию творчества 3. Придумать идею для цикла книг 4. Познакомиться с историей 5. Создать мир и героев 6. Выстроить сюжет 7. Продумать сцену/главу 8. Написать черновик 9. Вычитать текст 10. Сохранить важную информацию 1. Определиться с ЦА и ToV 2. Сформулировать цель документа 3. Составить структуру документа 4. Встретиться с экспертами 5. Погрузиться в сервис 6. Предугадать вопросы 7. Продумать страницу/раздел 8. Написать черновик 9. Провести ревью 10. Сохранить важную информацию
19. HARD SKILLS Техпис Писатель • Умение чётко и структурированно излагать мысли • Грамотность • Сбор, обработка и анализ информации • Навыки редактуры и корректуры • Образное мышление • Знание Scrivener, Microsoft Word, Google Документы • Умение чётко и структурированно излагать мысли • Грамотность • Сбор, обработка и анализ информации • Навыки редактуры и корректуры • Аналитическое мышление • Знание продуктов JIRA, Confluence, XML редакторов • Знание систем контроля версий GIT. SVN • Умение читать и писать код (опционально)
20. SOFT SKILLS Техпис Писатель • Ответственность и самостоятельность • Организованность и пунктуальность • Клиентроориентированность • Проактивность, желание обучаться • Способность учиться и решать сложные задачи • Умение работать в команде • Организаторские и коммуникативные навыки
21. Не домом единым
22. Творческий беспорядок
23. Страх чистого листа
24. Не столько пишем, сколько ищем
25. А я по полю, да по полюшку
27. Два сапога пара Hard-skills 50% Этапы пути 80% Книги 90% Soft-skills 100%
28. Фантазировать не вредно
29. Анна Мария Попова • Пишу под псевдонимом Анна Пауль • Публикую книги на Литнет • Веду блог ВК и канал ТГ Где почитать технический писатель