Проект BRL-CAD

На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.

Краткое описание проекта

Организация с открытым исходным кодом:
БРЛ-CAD
Технический писатель:
сахибкаур
Название проекта:
Руководство для начинающих по BRL-CAD
Длина проекта:
Стандартная продолжительность (3 месяца)

Описание Проекта

Руководство для начинающих по BRL-CAD

Аннотация к проекту

Этот проект направлен на создание документации, предназначенной для пользователей, которые не только плохо знакомы с BRL-CAD, но и с открытым исходным кодом.

Почему этот проект

Когда я впервые посетил веб-сайт BRL-CAD, поскольку я был новичком в области открытого исходного кода и BRL-CAD, я был ошеломлен количеством информации за один раз. Но в глубине души я знал, что здесь можно многому научиться. Итак, я хотел создать документацию для таких новых пользователей, как я, чтобы получить от этого сообщества много полезного и с легкостью начать работу.

Цели

Этот проект будет ориентирован на новых пользователей. Итак, ниже приведены некоторые моменты, которых моя документация призвана достичь: Чтобы новые пользователи чувствовали себя непринужденно: поскольку эта документация предназначена для новых пользователей, не только новичков в BRL-CAD, но и для новичков в открытом исходном коде.

Чтобы добиться этого, я буду:

  • Убедитесь, что оценка документа по Флешу-Кинкейду не ниже 50. Согласно методу Флеша-Кинкейда, чем выше оценка, тем легче понять текст. Вы можете проверить его оценку читабельности онлайн.
  • Используйте маркированные или нумерованные списки, чтобы читатели не скучали и не отвлекались на длинные абзацы.
  • Используйте более короткие абзацы и предложения, потому что для чтения и понимания более длинных предложений требуется сравнительно больше умственной работы.
  • Используйте подзаголовки, чтобы разбить текст. Хорошо структурированная документация. Хорошо структурированная документация играет решающую роль в руководстве новыми пользователями. Это не дает им заблудиться и сообщает им, куда они направляются и что делают. Для достижения этой цели я составил приблизительную ассоциативную карту, которая поможет нам систематизировать руководство для начинающих.

Описание Проекта

Этот проект направлен на написание документации для новых пользователей, которые смогут освоить это программное обеспечение.

Ниже приведен пример того, как я намерен сделать документацию более наглядной.

Базовое введение: BRL-CAD (произносится как be-are-el-cad) — это система автоматизированного проектирования (CAD) для твердотельного моделирования конструктивной твердотельной геометрии (CSG). Это мощная кроссплатформенная система твердотельного моделирования с открытым исходным кодом для автоматизированного 3D-проектирования и графической визуализации. Не можешь уложить в голове это? Давайте разберемся. Открытый исходный код. Программное обеспечение с открытым исходным кодом — это программное обеспечение с исходным кодом, которое каждый может проверять, изменять и улучшать. BRL-CAD — это программное обеспечение с открытым исходным кодом, которое приглашает вас внести свой вклад и сделать BRL-CAD лучше, чем раньше! Компьютерное проектирование (САПР). Проще говоря, САПР — это использование компьютерных программ для создания двух или трехмерного графического представления физических объектов. Система твердотельного моделирования: BRL-CAD специализируется на САПР твердотельного моделирования. Твердотельное моделирование отличается от других форм геометрического моделирования упором на физическую точность и полное описание трехмерного пространства. Он моделирует объект как внутри, так и снаружи. Конструктивная твердотельная геометрия (CSG): CSG позволяет представлять сложные модели как серию логических операций между примитивами. Простейшие твердые объекты, используемые для представления, называются примитивами. Чтобы понять CSG на фундаментальном уровне, посетите здесь .

*Как упоминалось в описании идеи проекта: документация будет как минимум охватывать базовую установку, общее описание возможностей, принципов моделирования BRL-CAD, базовое использование основных инструментов, моделирование, импорт/экспорт, анализ и рендеринг.

Ниже приведены краткие сведения о том, как я буду освещать каждую часть документации.

  • Базовая установка: я добавлю пошаговое руководство по установке программного обеспечения BRL-CAD вместе с необходимыми скриншотами. Учебное пособие для новичков — хорошее начало для новых пользователей. Вот некоторые вещи, которых мне не хватает:
  • Шаги этого руководства для начинающих не маркированы и не пронумерованы. Наличие пошагового руководства со снимком экрана в конце каждого шага повышает вероятность того, что пользователь заинтересуется руководством.
  • Общее описание возможностей. Этот раздел будет содержать все области, в которых BRL-CAD способен творить чудеса. Схематический подход будет лучшим способом привлечь внимание к этой части.
  • Принципы моделирования BRL-CAD. Эта часть потребует дополнительных объяснений, поскольку пользователь сможет лучше понять BRL-CAD, как только получит четкое представление об этих принципах моделирования.
  • Базовое использование основных инструментов: в рамках этой статьи у нас будут отдельные руководства по основным инструментам и их базовому использованию. Это будут пошаговые уроки.
  • Экспорт/Импорт: пользователи узнают о библиотеке преобразования геометрии. Одним из наиболее распространенных применений BRL-CAD является преобразование геометрии из одного формата в другой. В этом разделе мы обсуждаем конвертеры экспорта и импорта.
  • Рендеринг: мы рассмотрим основы рендеринга и необходимость его использования в нашем программном обеспечении. Пользователи также узнают, как визуализировать изображения в BRL-CAD.

Помимо этого, внимание также уделяется следующим моментам:

  • В начале документации будет дано общее представление о том, что представляет собой это программное обеспечение.
  • Как пользователи могут связаться с этим сообществом с открытым исходным кодом; ссылка на чат zulip BRL-CAD.
  • На абстрактном уровне: сделать документацию немного юмористической и попросить новых пользователей не расстраиваться из-за громких слов. Мне понравился чуткий подход, используемый на главной странице вики BRL-CAD.
  • Там будут скриншоты некоторых удивительных вещей, которые пользователи могут делать с помощью этого программного обеспечения.

Вехи

Июль (Период рассмотрения предложений)

  • Я познакомлюсь с программным обеспечением и его вики-документацией, изучая существующие учебные пособия.
  • Я буду вносить улучшения в существующие документы.

1 августа – 7 августа (связывание сообщества)

  • Обсуждение проекта с наставниками.
  • Уточнение деталей проекта.
  • Внесите необходимые изменения в этапы (при необходимости).

8 августа - 14 августа

  • Познакомьтесь с XML-документом Docbook

15 августа - 21 августа

  • Написание документации «Базовое введение в BRL-CAD»
  • Написание пошагового руководства по «Базовой установке»

22 августа – 27 августа

  • Изучение различных возможностей BRL-CAD и их перечисление вместе со скриншотами.
  • Объясните отдельные функции на отдельной странице.

28 августа – 3 сентября

  • Продолжайте работать над отдельными документами по возможностям.

4 сентября - 10 сентября

  • Работа над принципами моделирования.
  • Объяснение всех принципов моделирования.

11 сентября - 17 сентября

  • Работа над базовым использованием основных инструментов.
  • Составьте краткий список идей для документирования базового использования каждого инструмента.

18 сентября - 24 сентября

  • Документирование использования каждого инструмента.

25 сентября – 1 октября

  • Работайте над моделированием, чтобы создать твердую модель для урока, и параллельно напишите черновик.

2 октября - 8 октября

  • Улучшите эскиз модели.

2 октября - 8 октября

  • Изучение экспортно-импортных преобразователей.

9 октября - 15 октября

  • Подготовка экспортно-импортной документации.
  • Начинаем работать над рендерингом.

16 октября - 22 октября

  • Документирование руководства по рендерингу.

23 октября - 29 октября

  • Рассмотрение всех документов.

30 октября – 5 ноября

  • Работаем над XML Docbook

6 ноября - 12 ноября

  • Попросите отзывы у наставников и других членов сообщества и работайте над изменениями.
  • Обсуждаем с наставниками и вносим окончательные изменения.

12 ноября - 22 ноября

  • Обсуждаем и вносим изменения.
  • Последний штрих к документации.

Обо мне

Писанием я увлекаюсь со школьных лет. Я приходил домой из школы и писал все о своем дне; что сделало мой день лучше или хуже. Мне всегда хотелось записывать ошибки, которые я допустил, и то, как я могу их исправить.

Во время моего обучения на веб-дизайнера нас просили записывать то, что мы изучаем ежедневно. Я задокументировал некоторые проблемы, с которыми столкнулся, и их решение.

Как человек, я всегда стараюсь изо всех сил помогать другим. В школьные и студенческие годы я объяснял некоторые темы своим друзьям после того, как сам разобрался в этих темах. Участие в GSoD — это великолепный шаг, благодаря которому я, как писатель, могу внести свой вклад в то, чтобы сделать это сообщество с открытым исходным кодом более привлекательным и полезным для новых пользователей по всему миру.