На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- СхемаСтих
- Технический писатель:
- Прагати
- Название проекта:
- Пользовательская документация и руководства
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание проекта
После углубленного анализа аудитории и текущей доступной пользовательской документации я предлагаю следующие задачи по документированию:
1) Добавьте видеоуроки, чтобы продемонстрировать популярные рабочие процессы и улучшить процесс адаптации. Видео обрисуют единую концепцию. Видео укажет направление при выполнении этого действия на экране.
Ссылку на образец видеоурока по использованию инструмента комбинационного анализа можно найти здесь. https://www.youtube.com/watch?v=7FkeqBYcd1w Примечание 1. Хотя это видео иллюстрирует существующий контент, оно призвано показать, как можно использовать аннотации для создания единообразного стиля видео. Примечание 2. Когда я начну работать в CircuitVerse, я приобрету лицензию на программное обеспечение, и конечный продукт не будет содержать водяных знаков.
Рекомендуемые темы для рабочих процессов видеоуроков: --Начало работы с CircuitVerse: посмотрите это видеоруководство для быстрого ознакомления с CircuitVerse --Использование инструмента комбинационного анализа: просмотрите это видеоучебник, чтобы узнать, как создавать схемы с использованием данных таблицы истинности. --Экспорт изображений с высоким разрешением: посмотрите этот видеоурок, чтобы узнать, как экспортировать изображения ваших схем с высоким разрешением в различные форматы. --Использование подсхем для структурированного проектирования. Посмотрите этот видеоурок, чтобы узнать, как создавать подсхемы для упрощения структуры сложных схемы -- Использование инструмента Hex-Bin-Dec Converter: посмотрите этот видеоурок, чтобы узнать, как использовать инструмент Hex-Bin-Dec Converter для проектирования и реализации схем. --Визуализация временных диаграмм для заданной схемы. Посмотрите это видеоруководство, чтобы узнать, как пользователи могут визуализировать временные диаграммы для заданной схемы.
Некоторые видеоуроки могут быть связаны между собой на веб-страницах и в пользовательской документации.
2) Создайте целевую страницу с учебным пособием, на которой будет представлен краткий обзор платформы CircuitVerse, а также графическое представление различных рабочих процессов. Пользователи получат доступ к целевой странице учебных пособий на сайте Circuitverse GitHub, где будет представлен краткий обзор различных учебных пособий, предлагаемых для различных рабочих процессов с контентом. Это дает пользователю возможность просматривать и выбирать различные учебные пособия в соответствии со своими потребностями. Ниже приведен приблизительный образец структуры целевой страницы руководства.
3) Создайте пошаговые руководства, чтобы научить пользователей тому, как они могут использовать этот инструмент для изучения и анализа поведения базовых и сложных схем — обучайте инструменту, играя с ним. Что касается представленных проектов CircuitVerse, я предлагаю добавить как минимум 5 руководств для пользователей начального и среднего уровня для улучшения процесса адаптации. Каждое руководство, иллюстрирующее полный рабочий процесс, содержит введение в него, за которым следует процесс проектирования, список компонентов, пошаговые инструкции и практические упражнения. В случае сложных рабочих процессов видео будет охватывать отдельную часть общей концепции.
Посетите эту ссылку, чтобы просмотреть образец руководства: Создание семисегментного декодера: https://pragatijain.github.io/circuitverse/index.html.
Некоторые из тем включают в себя: --Создание вращающегося светодиодного дисплея --Изучите, как работает сумматор с пульсирующим переносом --Часть 1A: Анализ 4-битного компаратора величин --Часть 1B: Создание шестнадцатеричного калькулятора --Анализ конечного автомата ( ФСМ) реализация
4) Пересмотрите структуру навигации на боковой панели, чтобы улучшить согласованность, читабельность и связность.
Инструменты проекта 1) Camtasia для видеоуроков. Для создания примера видео я использовал пробную версию. Когда я начну работать в CircuitVerse, я куплю лицензию на программное обеспечение, и конечный продукт не будет содержать водяных знаков. 2) Документы Google для написания моих руководств, которые я позже обновлю на GitHub и разместим в репозитории CircuitVerse. 3) Wiki-разметка и HTML для управления моим контентом в GitHub.
Сроки: До 16 августа. Вносите свой вклад в развитие организации на GitHub.
Объединение сообщества (17 августа – 13 сентября) Установите канал связи и время (из-за разницы во времени). Уточнить свои цели и установить ожидания обеих сторон. Узнайте больше о сообществе и продукте. Обсудите и доработайте предложенную структуру документации с наставниками и другими членами организации.
Период документации Этот проект будет соответствовать стандартным рекомендациям по продолжительности проекта (всего 11 недель, с 14.09.2020 по 30.11.2020). Я буду тратить около 20 часов в неделю на достижение целей, изложенных ниже. Помимо этих целей, я буду в это время принимать участие в менторских встречах и общении по мере необходимости. Я буду работать с наставниками, чтобы определить лучшее время для этого. Примечание. Этот график является гибким и учитывает тот факт, что потребности организации могут измениться. Большие таймфреймы обеспечивают гибкость и возможность переключать фокус по мере необходимости.
Неделя 1. Просмотрите выявленные этапы и доработайте их. Формируйте репозиторий CircuitVerse и загрузите его на свою машину. Обсудите с наставниками стиль видео, а также разработайте шаблон начального экрана видео, любую музыку-вставку для заглавного и конечного экранов, а также дополнительную информацию, которая должен быть включен. Просмотрите темы видеоуроков и получите их одобрение. Определите темы учебных пособий и получите их одобрение. Проверьте структуру навигации боковой панели и получите ее одобрение.
Неделя 2. Создайте шаблон учебного пособия и получите его одобрение наставника. Создайте целевую страницу учебного пособия для размещения учебных пособий.
Недели 3, 4, 5. Добавьте видеоуроки для демонстрации различных рабочих процессов симулятора.
Недели 6, 7, 8, 9: Создание уроков для различных простых и сложных схем.
Неделя 10. Реструктуризация навигации на боковой панели для обеспечения единообразия и улучшения взаимодействия с пользователем.
Неделя 11: Проверьте мою работу на наличие опечаток и ошибок.
Соответствующие примеры работ CircuitVerse
*Перейдите по этой ссылке, чтобы просмотреть образец руководства: Создание семисегментного декодера. : https://pragatijain.github.io/circuitverse/index.html.
*Ссылку на образец видеоурока по использованию инструмента комбинационного анализа можно найти здесь. https://www.youtube.com/watch?v=7FkeqBYcd1w Примечание 1. Хотя это видео иллюстрирует существующий контент, оно призвано показать, как можно использовать аннотации для создания единообразного стиля видео. Примечание 2. Когда я начну работать в GDevelop, я куплю лицензию на программное обеспечение, и конечный продукт не будет содержать водяных знаков.
*Целевая страница учебного пособия по CircuitVerse https://docs.google.com/document/d/1sBKS2cq76zRHDGgA2Lbf7isSisRK_ELLSPsg-7atCAI/edit#
*Полное предложение можно просмотреть в документе Google: https://docs.google.com/document/d/1vzYyDnX6mFXXByrcwVsrxCgpIWKpcj8U8DSa3gVB7RA/edit#.
Пример шаблона учебного пособия: 7-сегментный декодер 7-сегментный декодер
Обзор:
В этом руководстве представлены различные этапы создания 7-сегментного декодера с использованием CircuitVerse. Декодер — это комбинационная схема, которая преобразует двоичное число в соответствующее десятичное число. Он принимает четыре бита на входе и имеет семь выходов.
Процедура проектирования
Для создания схемы 7-сегментного дисплея в CircuitVerse мы выполним следующие шаги: Используйте инструмент комбинационного анализа, доступный в симуляторе CircuitVerse, чтобы сформулировать таблицу истинности. Используя эту таблицу истинности, мы затем сгенерируем схему в симуляторе. Эта схема будет выводить выходные данные на семисегментный светодиодный дисплей. Подключите соответствующие метки комбинационной схемы к соответствующим выходам семисегментного светодиодного дисплея, чтобы увидеть нашу схему в действии. Семисегментный дисплей — это электронное устройство отображения десятичных цифр от 0 до 9. См. Анализ поведения схемы с использованием данных таблицы истинности. Таблица истинности В таблице 1 ниже перечислены различные выходные данные для различных комбинаций входных сигналов 7-сегментного декодера.
Список элементов CircuitVerse
В таблице 2 перечислены различные компоненты, необходимые для реализации схемы.
Сформулируйте таблицу истинности
Выполните следующие шаги, чтобы сформулировать таблицу истинности в симуляторе CircuitVerse:
Завершите схему
Обратитесь к рисунку 10, чтобы подключить соответствующие входные провода для соответствующих меток комбинационной схемы к соответствующим выходам семисегментного дисплея для завершения схемы. В этом видео демонстрируется смоделированная схема 7-сегментного декодера, созданная в симуляторе CircuitVerse. Ссылка на видео: https://www.youtube.com/embed/tGTy4P-RxP0
Анализ схемы
Переключите различные входные значения (S3, S2, S1, S0) и проверьте таблицу истинности (см. Таблицу 1), чтобы проверить реализованную схему семисегментного декодера.
Компонент семисегментного дисплея содержит 8 светодиодных сегментов внутри, один конец их контактов вытянут из модуля, как показано на рисунке 8. Чтобы светодиод определенного сегмента светился, соответствующие сегменты (обозначенные как a, b, c, d, e, f, g на рисунке 10) должно быть включено для представления чисел от 0 до 9. Например, для отображения цифры 1 необходимо включить светодиоды b и c.
Если светодиод не отображает правильное десятичное число, обратитесь к Таблице 3 и Рисунку 10 и устраните неисправности проводных соединений. В Таблице 3 приведена конфигурация контактов 7-сегментного дисплея.