Шаблон описания проекта

Материал из MK90.ORG wiki
Перейти к:навигация, поиск

Важная информация о текущем состоянии проекта

Введение

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

Возможности

  • возможность 1
  • возможность 2

Идеи использования

  • идея 1
  • идея 2

Предупреждения

Описание и предупреждения о любых действиях, несущих опасность.

Схема

Схема устройства, ссылки на файлы в формате Eagle/PDF

Спецификации

Возможные спецификации устройства

Входы и напряжения

Интерфейс с внешним миром

Механические размеры

Использование

Основные хинты по использованию

Аппаратная установка

Программирование

Важные моменты, связанные с программированием

пример демо-кода :

<syntaxhighlight lang="c++">

Demo code { }

</syntaxhighlight>

Примеры

Примеры использования проекта

Bill of Materials (BOM) / список компонентов

Список компонентов, использованный для изготовления

FAQ

Что такое N?

Ответ: N - это ...

Поддержка

Если у вас есть любые вопросы, вы можете задать их в форуме.


История версий

Ревизия Описание Дата выпуска
N R1 Первый публичный релиз YYYYMMDD

Багтрекер

Любые обнаруженные ошибки и методы из устранения

Идеи по улучшению

Дополнительные идеи по улучшению функциональности и пр.

Ресурсы

  • [URL Source file]

Где купить

Ссылка на страницу для покупки

Смотри также

Похожие/связанные проекты и ресурсы

Лицензирование

Эта документация лицензирована под Creative Commons Attribution-ShareAlike License 3.0, исходный код и библиотеки лицензированы под GPL/LGPL, более подробно см. в архивах с исходным кодом.

Внешние ссылки

Линки и внешние ссылки на страницы с дополнительными идеями, документацией, даташитами и библиотеками