User Tools

Site Tools


autolab:wiki_guide

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
autolab:wiki_guide [2022/10/14 11:59]
pro100kot created
autolab:wiki_guide [2022/12/10 09:08] (current)
Line 2: Line 2:
  
  
 +===== Цель данной Wiki =====
 +
 +Cоздать банк знаний для работы в Лаборатории. Каждая инструкция должна быть полноценной, ​ без расчета на то, что у читателя есть какой нибудь background. На каждой странице должно быть:
 +  - Ccылка на репозиторий,​ если есть проект;​
 +  - Ссылка на документацию,​ если есть;
 +  - Если страница описывает работу с каким либо оборудованием - должно быть описано где оно находится(Картинка или текстовое описание);​
 +  - Полная последовательность команд для корректной работы программы/​оборудование и так далее
 +
 +===== Что запрещено делать на Wiki? =====
 +
 +  - Загружать большие данные,​ которые занимают много места(мб)
 +  - Копировать текст документации сюда
 +
 +
 +===== Ревью новых страниц =====
 +
 +Каждая новая страница должна пройти ревью другого человека. Желательно,​ чтобы человек максимально был далек от предметной области,​ которая описывается на странице. "​Если ничего незнающий человек смог по Вашей инструкции все правильно запустить и так далее, значит инструкция хорошая. Если нет, значит есть что еще добавить"​
autolab/wiki_guide.1665748753.txt.gz · Last modified: 2022/12/10 09:08 (external edit)