Платформа для документации
Братья-разработчики, помогите с идеями. Есть проект с кучей понятий и значений, я врабатываюсь, а документация от предыдущего разработчика скромно уместилась на девяти листах ворда. А у меня с менеджерами "несостыковочка", они раз так кнопочку назовут, раз эдак, причем функционалитет за кнопками схожий - и на выходе просто песня, хотели не то, не так и не туда.
Два месяца я послушала это все - и созрела - хочу общедоступную платформу, где бы хранились данные о проекте, где бы можно было создавать разделы и подразделы, и где бы поиск работал, как влитой. На прошлой фирме у нас был confluence, эта фирма, хоть и крупней предыдущей, привыкла обходиться своими силами, то бишь, фиг разорятся на платную вещь.
Кто может что-то посоветовать? Ну ооочень надо...
документация от предыдущего разработчика скромно уместилась на девяти листах ворда
------
У меня - чуть больше, но с картинками.
Очень добросовестно сфотканы компы, места их установки, внешний вид в закрытом и открыом состоянии, вид сбоку, вид с задУ.
Все, кроме описания структур данных и методов обсчета...
После меня останется не больше чем было. Просто код будет более/менее обьектным.
А так - да, тоже хочу что-то, что подсобит с документированием системы и изменений.
привыкла обходиться своими силами, то бишь, фиг разорятся на платную вещь.
Ты перешла к нам? :)
В любом случае, если нет центральной системы, то ты конечно можешь поднять ее для себя/своего отдела, но никто кроме тебя этим пользоваться не будет.
Для документации хорошо подходят всякие вики-системы. Для трекинга задач надо смотреть либо что-то встроенное (если у тебя есть MS подписка, то можешь поднять TFS. Про нее можно и у IT спросить, возможно у них есть лицензия), либо искать что-то бесплатное (redmine не бери :))
TSF слава богу есть! Но это не то место, где структурированно можно почитать. Да, хочу что-то "вики"-подобное, пусть даже только для себя. Просто перелопачиваю код, понятно, что не все в голове с первого раза останется. Мелочевки много, которую б зафиксировать...
А вот это и есть главная проблема! Когда я с менеджером подошла к шефу, то всегда улыбчивый дядечка искривился в лице и сказал "нафига оно надо..." Так что напрягать не могу, могу лишь предложить свой (бесплатный) вариант, аргументировав легкость управления и защищенность данных.
Когда я с менеджером подошла к шефу, то всегда улыбчивый дядечка искривился в лице и сказал "нафига оно надо..." Так что напрягать не могу, могу лишь предложить свой (бесплатный) вариант, аргументировав легкость управления и защищенность данных.
Мне кажется, что ты сделала неправильный вывод :) "Нафига это надо?" означает, что шефу нужно обоснование внедрения нового инструмента.
Грубо говоря, почему они смогли проработать предыдущие 10 лет без этого и больше не могут :)
дык... поэтому сейчас и ищу что-нибудь, чтоб не голословно потом шефу представить. У нас просто в договоре прописано - установка любого ПО только с личного разрешения руководства :О
А вот это и есть главная проблема! Когда я с менеджером подошла к шефу, то всегда улыбчивый дядечка искривился в лице и сказал "нафига оно надо..."
Велкам ту зе клаб!
У нас тоже месенджера нет. И тоже каждый чих пробивать нужно. Благо что наш шеф отдела полностью на нашей стороне а выше мрак... все застряли в 80х годах. Есть рорпост и всё на бумаге, даже антраги на отпуск 8-0
Шеф пару лет бился за вики. Добился. Сейчас многие другие отделы начинают потихоньку использовать. Но все на наших плечах. Сервер у коллеги под столом. А айти отдел в состоянии только компы инсталлировать и принтеры заправлять...
Пошла ва-банк. Составила на пару страничек презентацию, распечатала, и вывалила без предупреждения на планерке. Коллеги так оживились (что для меня было приятным сюрпризом), что сами начали убеждать шефа в необходимости. Шеф сдался и обещал попробовать.
может отсюда что подойдет?
https://en.wikipedia.org/wiki/Comparison_of_wiki_hosting_s...
или вот тут дискуссия людей с опытом:
https://top.quora.com/What-is-the-best-tool-for-creating-f...
Вот же ж шило в одном месте 
А ты еще пробецайт не прошла.
Хотя я сегодня тоже отличилась. Сначала спорила с коллегой, что другие коллеги спросили, снимаем ли мы ролик для ютуба 
Потом я сокрушалась, что ничего на фирме нет, ни мороженого, ни льда, ни кондиционера. И вот спустя некоторое время тимляйтер притащил всем мороженого. Неужели я такая громкая была?
А по сабжу. На той фирме была конфлуенс, но как-то не слишком было все централизовано. Как по мне, надо код комментировать и на основе комментариев генерировать документацию для разработчиков.
надо код комментировать и на основе комментариев генерировать документацию для разработчиков
------
Комментировать - надо.
Но! комментарии к коду не заменяют документацию для разработчика.
Сейчас вот ковыряю старый ВБ6-лике код.
Работает он так:
- с сервера грузится куча данных
- из данных производится подвыборка по ордерам
- из подвыборки производится еще подвыборка - по штукам
- снова подвыборка по критериям, пока не останется что-то, что знают как обсчитать.
Все это размазано где-то на 14-15.000 строк. Работает - минут 40...
Можно все это безобразие аккуратно прокомментировать, но занятие - совершенно бессмысленное.
Дело в том, что добавить туда что-то или поменять там что-то - невозможно - ни с комментариями, ни без них. ВБ6-лике.
Однако все это можно заменить всего лишь двойным циклом - 10-15 строками - и отдельными
методами обсчета для каждой единицы наличного оборудования.
Получится достаточно просто и сопровождаемо.
Но для этого - нужна дока в которой написано не как (комментарии) оно считается,
а что (тех.требования) там пытаются посчитать.