瀏覽代碼

Добавление шаблонов документации

MeseryGG 5 月之前
父節點
當前提交
f62dfb1eb6

+ 39 - 0
README-Template_rus.md

@@ -0,0 +1,39 @@
+# Заголовок проекта
+
+Один абзац описания проекта находится здесь
+
+## Начало работы
+
+Эти инструкции предоставят вам копию проекта и помогут запустить на вашем локальном компьютере для разработки и тестирования.
+
+### Необходимые условия
+
+Что нужно для установки программного обеспечения и как его установить
+
+```
+Предоставьте примеры
+```
+
+### Установка
+
+Пошаговая серия примеров, которые говорят, что вы должны запустить
+
+Скажи, какой будет шаг
+
+```
+Приведи пример
+```
+
+И повтори
+
+```
+Пока не закончил
+```
+
+Завершите пример получением некоторых данных о системе или использования их для небольшой демонстрации
+
+## Авторы
+
+* **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth)
+
+See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.

+ 16 - 0
ЗаготовкаПодРуководствоСистемногоПрограммиста.docx

@@ -0,0 +1,16 @@
+   Руководство системного программиста должно содержать следующие разделы:
+ общие сведения о программе;
+ структура программы;
+ настройка программы;
+ проверка программы; 
+ дополнительные возможности;
+ сообщения системному программисту.
+   В разделе "Общие сведения о программе" должны быть указаны назначение и функции программы и сведения о технических и программных средствах, обеспечивающих выполнение данной программы.
+   В разделе "Структура программы" должны быть приведены сведения о структуре программы, ее составных частях, о связях между составными частями и о связях с другими программами.
+   В разделе "Настройка программы" должно быть приведено описание действий по настройке программы на условия конкретного применения (настройка на состав технических средств, выбор функций и др.).
+   При необходимости приводят поясняющие примеры.
+   В разделе "Проверка программы" должно быть приведено описание способов проверки, позволяющих дать общее заключение о работоспособности программы (контрольные примеры, методы прогона, результаты).
+   В разделе "Дополнительные возможности" должно быть приведено описание дополнительных разделов функциональных возможностей программы и способов их выбора.
+   В разделе "Сообщения системному программисту" должны быть указаны тексты сообщений, выдаваемых в ходе выполнения настройки, проверки программы, а также в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
+   В приложении к руководству системного программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.).
+