На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Проект GoodDocs
- Технический писатель:
- Болтливость
- Название проекта:
- Руководство по информационной архитектуре
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание Проекта
План руководства по информационной архитектуре
В этом документе рассматривается планирование руководства по информационной архитектуре для проекта Good Docs. Он был подготовлен в рамках представления Google Season of Docs 2020. В нем описывается вариант использования предлагаемого руководства и обрисовывается план структуры такого руководства для целей планирования.
Информационная архитектура (IA) касается организации контента. Он охватывает структуру контента без определения стиля или слов, используемых в самом контенте. Например, план IA будет учитывать, кто является читателем, как он подходит к содержанию и в какой среде он читает. Затем будет рассмотрена соответствующая структура контента, которая лучше всего будет отвечать этим требованиям читателей.
В идеальном мире разработка документации начинается с разработки контентной стратегии, которая использует бизнес-цели для определения целей документации. Стратегия содержания затем используется для создания IA, который определяет макет и структуру документации. Отсюда можно выбрать цепочки инструментов и написать контент. Реальность большинства проектов с открытым исходным кодом такова, что стратегия контента так же проста, как «написать некоторую документацию, чтобы люди знали, как использовать этот проект», но даже этой простой стратегии достаточно, чтобы определить эффективную IA.
Цель этого руководства — предоставить непрофессиональным писателям упрощенный инструмент для разработки IA, достаточного для определения того, какие шаблоны им следует использовать. Оно должно быть достаточно простым, чтобы его мог выполнить обычный человек за полдня, и в нем должно отдаваться предпочтение действию, а не образованию. В идеале он представляет концепции в краткой форме, помогает читателю рассмотреть эти концепции применительно к их собственному проекту и использовать результат для перехода к следующей концепции.
В качестве основы для этого проекта потребуются некоторые обновления README проекта, чтобы читатели понимали, как начать работу с проектом Good Docs, и могли эффективно использовать руководство IA для выбора шаблона.
Основная аудитория
Всем, кто хочет использовать шаблоны The Good Docs Project для создания документации для своего проекта.
Варианты использования. Этот раздел предназначен для изучения того, как читатели относятся к Руководству по IA. Это может помочь нам определить, как следует структурировать руководство, чтобы оно было максимально полезным для читателей.
Сценарий: человек работает над проектом с открытым исходным кодом, по которому мало или совсем нет документации, или над пакетом документации, который плохо организован или написан. Они решают использовать проект Good Docs Project для организации своей документации, но не знают, с чего начать. Они следуют README, чтобы понять, как начать работу с шаблонами, и следуют Information Architecture Guide , чтобы разработать свою стратегию содержания и спланировать, как будет выглядеть их пакет документации.
Предложение
Обновите README, чтобы более четко провести нового читателя по проекту, включая четкие первые шаги. Одним из таких первых шагов будет чтение и ответы на вопросы нового Руководства по ВА. Это руководство предложит читателю рассмотреть аудиторию, схему контента, матрицы пользователей/задач и т. д., не возлагая на читателя слишком большого бремени, связанного с изучением/пониманием того, что это за вещи в академическом смысле. После выполнения этой задачи читатель поймет, какие шаблоны требуются и как их лучше всего заполнить.
Исследовать
Чтобы подкрепить это исследованием, я бы в значительной степени опирался на книгу Эбби Коверт (http://www.howtomakesenseofanymess.com/), отчасти потому, что я очень хорошо с ней знаком и она легла в основу многих контент, который я уже написал и буду использовать, но также и потому, что людям, впервые знакомым с IA, очень легко подобрать и прочитать, если у них возникнет дальнейший интерес. В этом смысле это что-то вроде наркотика-шлюза IA.
Проект ТЗ
ПРОЧТИ МЕНЯ:
-- Введение в проект Good Docs |_ Кто должен использовать шаблоны |_ Как работают шаблоны |_ Участие в проекте -- Шаблоны |_ Список всех текущих шаблонов |_ Выбор шаблонов для использования |_ Прежде чем начать -- Прежде чем начать писать |_ Кто читает документацию? |_ Почему они читают документацию? |_ Пишу для ваших читателей
Руководство ИА:
-- Введение |_ Что такое IA? |_ Почему меня это должно волновать? -- Определите беспорядок -- Изложите свои намерения -- Взгляните в лицо реальности -- Выберите направление -- Измерьте расстояние -- Поиграйте со структурой -- Приготовьтесь приспособиться