Проект CircuitVerse

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

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

Организация с открытым исходным кодом:
СхемаСтих
Технический писатель:
dvls
Название проекта:
Объединение и улучшения интерактивных книг CircuitVerse
Длина проекта:
Стандартная продолжительность (3 месяца)

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

1 Аннотация

CircuitVerse — это проект с открытым исходным кодом, цель которого — предоставить платформу, на которой можно проектировать и моделировать схемы с использованием графического веб-интерфейса пользователя. Логический симулятор можно использовать для разработки полных реализаций ЦП, хотя он предназначен в первую очередь для использования в образовательных целях. Помимо технической документации к программному обеспечению, интерактивная онлайн-книга помогает пользователю изучить проектирование цифровой логики. Книга позволяет пользователю опробовать схемы прямо из книги для интерактивного опыта.

Книга находится на ранней стадии разработки, и в настоящее время в ней отсутствуют некоторые соответствующие разделы, общая структура неплотна с точки зрения потока, соединяющего различные разделы, и требует более подробного содержания. Более того, по данным организации, не существует руководящих принципов, помогающих участникам сотрудничать в проекте, а также плана или дорожной карты, указывающих, какой контент необходим и с каким приоритетом.

Цели этого предложения — сотрудничать с наставниками для создания руководящих принципов участия, разработки плана развития темы и внесения вклада в улучшение текущего контента, а также в создание нового контента в соответствии с планом развития.

2 Текущее состояние интерактивной книги

С момента запуска проекта на Google Summer of Code 2019 он продемонстрировал «неуправляемый рост» благодаря помощи студенческого сообщества. Сама проектная организация формируется в основном разработчиками, поэтому они взяли часть GSoD для поиска внешней помощи для улучшения Интерактивной книги. Разработчики проекта отмечают, что в настоящее время книгу требуют переписать некоторые разделы, добавить новое содержание и сделать ее более подробной и всеобъемлющей. Более того, команда ожидает, что после GSoD у нее будут рекомендации для новых участников, а также общий «генеральный план» разработки контента.

3 Каков вклад этого предложения

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

4 Анализ доступных альтернатив

Несколько зрелых проектов с открытым исходным кодом со схожими характеристиками уже разработали рекомендации по созданию документации, такие как Wikibooks ([Справка:Содействие], [Wikibooks:Политики и рекомендации]), OpenStreetMap ([Руководство по организованному редактированию]) или The Linux Documentation Project ([ Руководство автора ЛДП]). Эти примеры можно использовать для построения руководящих принципов проекта на основе опыта успешных проектов с открытым исходным кодом.

Для плана развития темы можно сравнить программы открытых курсов (например, [MIT Open Courseware]), а также справочники по цифровым логическим схемам, включая открытые книги, такие как [Уроки электрических цепей — том IV — цифровые]. [Викибуки: цифровые схемы] и [Викибуки: цифровая электроника].

[Справка: вклад] https://en.wikibooks.org/wiki/Help: вклад

[Викибуки:Политики и рекомендации] https://en.wikibooks.org/wiki/Wikibooks:Policies_and_guidelines

[Руководство по организованному редактированию] https://wiki.osmfoundation.org/wiki/Organized_Editing_Guidelines

[Руководство автора LDP] https://www.tldp.org/LDP/LDP-Author-Guide/html/index.html

[Открытые курсы MIT] https://ocw.mit.edu/

[Уроки электрических цепей – Том IV – Цифровой] https://www.ibiblio.org/kuphaldt/electricCircuits/Digital/index.html

[Викибуки: цифровые схемы] https://en.wikibooks.org/wiki/Digital_Circuits

[Викибуки: цифровая электроника] https://en.wikibooks.org/wiki/Digital_Electronics

5 Структура предлагаемой документации

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

Чтобы устранить неоднородность пользователей книги, предлагается «многослойная» структура, где каждый уровень соответствует возрастающему уровню сложности и теоретической глубине содержания.

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

В следующем структурированном списке представлена ​​предлагаемая двумерная структура. Стандартная последовательность тем представлена ​​на самом верхнем уровне. Для простоты для каждой темы определены только три уровня сложности, соответствующие базовому, среднему и продвинутому уровням. Для каждого уровня указано содержимое, относящееся к определенной общей теме.

  • Представление с использованием двоичных чисел:
    • Базовый уровень: Двоичные числа, Отрицательные величины, Другие основы, Кодификация.
    • Средний уровень: [нет конкретного содержания]
    • Продвинутый уровень: Модули и кольца
  • Математические операции с двоичными числами:
    • Базовый уровень: Сложение, Вычитание, Умножение, Деление.
    • Средний уровень: булева алгебра, булевы функции.
    • Продвинутый уровень: Другие алгебры, разложение Шеннона.
  • Комбинированные компоненты SSI:
    • Базовый уровень: символы, логические элементы, таблицы истинности.
    • Средний уровень: логические семейства, универсальные вентили.
    • Продвинутый уровень: Временное поведение (временные модели, опасности)
  • Комбинированная логика:
    • Базовый уровень: Функциональное описание, Реализация.
    • Средний уровень: канонические функции, k-Maps.
    • Продвинутый уровень: переменные, вводимые с помощью карты, Куайн МакКласки, представление двоичных кубов.
  • Комбинированные компоненты MSI:
    • Базовый уровень: MUX, DEMUX, кодер, декодер, полусумматор, полный сумматор.
    • Средний уровень: функции на основе MUX
    • Продвинутый уровень: [нет конкретного содержания]
  • Комбинированные компоненты БИС:
    • Базовый уровень: ПЗУ, АЛУ
    • Средний уровень: PLD (PLA, PAL, GAL)
    • Продвинутый уровень: [нет конкретного содержания]
  • Последовательные компоненты SSI:
    • Базовый уровень: защелки, триггеры, тактовые сигналы, временные диаграммы.
    • Средний уровень: обратная связь с памятью, синхронные системы, асинхронные системы.
    • Продвинутый уровень: [нет конкретного содержания]
  • Последовательные компоненты MSI:
    • Базовый уровень: регистры, счетчики
    • Средний уровень: [нет конкретного содержания]
    • Продвинутый уровень: [нет конкретного содержания]

  • Последовательное проектирование:

    • Базовый уровень: [нет конкретного содержания]
    • Средний уровень: последовательный синтез, автомат (Мили, Мур), диаграммы состояний, минимизация состояний, присвоение состояний, условия гонки.
    • Продвинутый уровень: проектирование на основе MSI, проектирование на основе LSI, блок-схемы, диаграммы MDS.

    Базовый уровень должен позволять пользователям понимать, как работают цифровые логические схемы и как их использовать, не требуя знаний высшей математики. Таким образом, он может подойти любителям-любителям и студентам средних школ. Если эти пользователи обладают необходимыми навыками и хотят добиться более глубокого понимания, они могут работать с частью или всем содержимым среднего уровня.

    Средний уровень должен быть эквивалентен по содержанию и требованиям вводному курсу по цифровой логической системе уровня высшего образования.

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

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

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

6 голов

  1. Подготовьте первый проект руководящих принципов участия в проекте «Интерактивная книга».
  2. Наметьте развитие тем книги.
  3. Перепишите и реструктурируйте текущий контент.
  4. Создавать новый контент согласно плану разработки.

7 Хронология

Неделя 1: (14 – 20 сентября) Проанализируйте и обсудите с наставниками лучшие рекомендации, основанные на примерах других проектов, а также на опыте, полученном на данный момент в проекте. Неделя 2: (21 сентября – 27 сентября) Напишите проект руководства. Неделя 3: (28 сентября – 4 октября) Обсудите проект плана разработки темы с наставниками. Неделя 4: (5–11 октября) Напишите план развития. Недели с 5 по 11: (12 октября – 29 ноября) Напишите материалы, состоящие из реструктурированного содержания, а также новых тем. Неделя 12: (30 ноября – 5 декабря) Представление отчета по проекту. Оценка проекта: (3 декабря – 10 декабря) – Представление оценки технического писателя. - Представление оценок наставников.

8 Почему интерактивная книга CircuitVerse

Из-за глобального кризиса COVID-19 я начал искать онлайн-ресурсы, которые могли бы помочь моим студентам бакалавриата по цифровым логическим системам. Я являюсь сторонником технологий Free-Libre с открытым исходным кодом уже несколько десятилетий, поэтому я отдаю приоритет такого рода проектам. Я нашел симулятор CircuitVerse и решил, что это отличный инструмент, дополняющий отсутствие лабораторной деятельности из-за мер по сдерживанию COVID-19 в нашем университете. Тестируя симулятор, я также нашел их интерактивную книгу, и хотя ее содержания еще не было достаточно в качестве основного справочника для полного курса по цифровым логическим системам, ее текущее содержание было правильным и простым для понимания, поэтому я включил ее в учебные ресурсы. .

Поскольку я интенсивно использовал их симулятор и книгу, представители организации связались со мной и рассказали мне о GSoD. Я увидел в этом возможность внести свой вклад в проект прямо из своей области знаний.

9 ссылок

  • [Справка Wikibooks:Внесение вклада],
  • [Викибуки:Политики и рекомендации]
  • [Руководство по организованному редактированию OpenStreetMap]
  • [Руководство автора проекта документации Linux (LDP)]
  • [Вводная учебная программа лаборатории цифровых систем MIT Open Courseware]
  • [Уроки электрических цепей - Том IV - Цифровой]
  • [Викибуки: цифровые схемы]
  • [Викибуки: Цифровая электроника]

  • [Проект брошюры по Linux]

    [Справка Wikibooks: Участие] https://en.wikibooks.org/wiki/Help: Contributing

    [Викибуки:Политики и рекомендации] https://en.wikibooks.org/wiki/Wikibooks:Policies_and_guidelines

    [Руководство по организованному редактированию OpenStreetMap] https://wiki.osmfoundation.org/wiki/Organized_Editing_Guidelines

    [Руководство автора проекта документации Linux (LDP)] https://www.tldp.org/LDP/LDP-Author-Guide/html/index.html

    [Вводная учебная программа лаборатории цифровых систем MIT Open Courseware] https://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-111-introductory-digital-systems-laboratory-spring-2006/syllabus/

    [Уроки электрических цепей – Том IV – Цифровой] https://www.ibiblio.org/kuphaldt/electricCircuits/Digital/index.html

    [Викибуки: цифровые схемы] https://en.wikibooks.org/wiki/Digital_Circuits

    [Викибуки: цифровая электроника] https://en.wikibooks.org/wiki/Digital_Electronics

    [Проект брошюры по Linux] http://lbproject.sourceforge.net/