На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- PostgreSQL
- Технический писатель:
- Лу
- Название проекта:
- Вводное руководство
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание Проекта
Обновите вводное руководство, чтобы улучшить процесс установки и настройки PostgreSQL для новичков. ( https://www.postgresql.org/docs/current/tutorial-start.html )
Превратите главу «Основы архитектуры» в подробное введение в учебные пособия по PostgreSQL ( https://www.postgresql.org/docs/current/tutorial-arch.html ). Возможные темы для расширения: архитектура клиент-сервер, psql в качестве примера клиента, который будет использоваться в этом руководстве, терминология «кластера» в контексте PostgreSQL, пользователи БД и ОС и право собственности.
Руководство по установке обновления ( https://www.postgresql.org/docs/current/tutorial-install.html ).
- Объявите как исходные, так и двоичные варианты установки. Добавьте ссылку на https://www.postgresql.org/download/ , которая предлагает минимальные двоичные инструкции по установке.
- Выявите пробелы в двоичных инструкциях по установке, если таковые имеются, и либо расширьте веб-сайт, либо устраните их в документации.
- Не полагайтесь на то, что пользователи прочитают полную главу об установке исходного кода и разберутся в ней: опишите основные шаги, необходимые после установки, такие как инициализация кластера и (авто)запуск сервера. При необходимости предоставьте ссылки на конкретные главы документации для получения более подробной информации.
- Добавьте ссылки «см. также» на соответствующие ресурсы, в которых подробно описаны настройки по умолчанию и лучшие практики для конкретной ОС, если таковые признаны сообществом.
Улучшите https://www.postgresql.org/docs/current/tutorial-createdb.html .
- Избавьтесь от инструкций «обратиться к администратору», где это возможно; предоставлять действенные решения, основанные на предположении, что пользователь шаг за шагом следовал руководству.
Улучшите https://www.postgresql.org/docs/current/tutorial-accessdb.html .
- Объясните основные проблемы, связанные с аутентификацией, и тривиальные примеры pg_hba.conf.
Чтобы предоставить этот патч документации, я намерен опробовать текущий учебник по Windows и Ubuntu, просмотреть форумы на предмет частых проблем с установкой и проконсультироваться с наставниками, чтобы убедиться, что я правильно понимаю лучшие практики и наиболее важные концепции объяснены без чрезмерного упрощения.