О! Она короткая, щас почитаю )))
Тю, капитан кэп ))
Да, надо делать документацию, но блин, даже не написано почему...
Если вы никогда не пробовали, то даже не представляете себе насколько это сложно просто заставить себя что-то написать, осознавая весь объём документации ))) Да, круто вот так: "а с сегодняшнего дня мы будем вести документацию"...
Да только ни хрена у вас в этом случае не выйдет. Я вам гарантирую. Мы сто раз так пробовали, в итоге ни фига до сих пор не вышло. А всё от того, что мы ни разу не пытались подумать, а как это вообще писать документацию? Ведь во всём всегда есть свой оптимум и свои трюки, чаще всего они совсем не такие, каким вы его себе представляете, вы наверняка сталкивались с такими вещами, особенно если получали высшее образование.
Документацию нужно вести эффективно, читай, оптимально, и я надеялся, что тут будет описание того, как это делать. А тут только дешёвые игрушечные примеры, которые не составляют никакой картины. Документацию нужно вести не для документации, а для того, чтобы она РЕАЛЬНО приносила пользу. При этом её нужно составлять так, чтобы она требовала МИНИМУМ времени и усилий. Вы лишены всей этой бюрократии и позёрства для начальства, у вас всё в настоящее, когда в коммерции много фальши, вот этим и пользуйтесь. Если что-то не приносит пользу, то за кой черт вообще это делать?! С той же документацией, ответьте себе на вопрос - ЗАЧЕМ ОНА ВАМ НУЖНА? Каковы задачи её существования? Чётко себе сформулируйте. Вот, например, я формулирую чёткие задачи, которые выполняет документация в нашем проекте (вы сразу поймете какую пользу она приносит):
1) Документация осуществляет структурированную передачу знаний о проекте от меня к другим участникам команды;
2) Документация нужна, чтобы не забыть всё, что мы придумали (реализовали, оттестировали и сделали выводы <- вот эти все слова важно не забыть, а-ля "что? где? когда?");
3) С помощью документации можно понять в какой точке разработки вы находитесь и сколько вам ещё предстоит сделать;
4) Документация нужна, чтобы ввести новых членов команды в курс дела более детально, чем на словах.
Элементарно ведь? ) Но сразу всё понятно, зачем мы её будем писать! ) И сразу видно, что не потому, что так написано в статьях и не потому, что так дяди в коммерции делают )
Что важно выше - это задачи, а не цели. Цель ещё предстоит сформулировать. Цель - это куда мы хотим попасть )
Поэтому формат документации и все формулировки внутри очень важны.
То что автор пишет что-то не юзабельное и составлялась это каким-то кренделем понятно уже сходу:
Цитата:"Engine: SOURCE
Developer: Biomass Productions
Start Date:Nov 2008
End Date:---
Estimated Price: FREE
Genre: Story Driven First Person Shooter
Ну что это за позёрство под коммерческие госты? О_о Тут только последняя строчка относится к сути, остальное "тааааак, а что бы ещё написать? А напишу-ка я тут всё как в коммерции пишут!" Совершенно не думает о том, что это потом кто-то будет читать и этот кто-то экономит своё время.
Ах да, очень важно, забудьте о том, чтобы повторять то, что делают в коммерции. Просто ознакомьтесь с этим, но не пытайтесь повторить - ищите свой путь. Каждая команда уникальна и даже когда приходит один человек, очень многое меняется. Потому шаблоны не обязательно будут работать для вашей команды. Каждое решение которое вы принимаете должно иметь под собой четкое, правдивое обоснование, которое выдерживает критику, а не просто "а давайте теперь будем делать вот так, потому что дяди из большой конторы вот так делают" и тормозите тех, кто под впечатлением у подобного, они только вред принесут, особенно если вы принимаете решения. Выработайте себе реакцию на подобное мнение: "нельзя слушать это мнение ни в коем случае" и попросите человека обосновать, а как он сам видит принесёт пользу его предложение и почему, пусть попробует обосновать, если человек высказывает своё мнение будучи под впечатлением, то он не сможет этого сделать, потому что он видит только эмоции, а не логическое обоснование. Если вы сами под впечатлением - отложите принятие решения, иначе пожалеете потом. Иногда человеку тяжело объяснить, что он под впечатлением и приходится принимать решение за него насильно, но это всегда можно сделать не очень заметно, чтобы не оскорбить чьи-то чувства, ибо подобное сказывается на желании работать, потому нельзя делать это часто, чаще команда должна сама приходить к тем мыслям, которые вы от них хотите получать. В общем вы должны чётко понимать зачем вы это делаете и какие результаты вы ждёте, даже без того, чтобы объяснять их кому-то, наедине с собой - не лгите себе, решение должно быть вашим, а не чьим-то и логически обоснованным. Пользуйтесь головой и с коммерции берите основные мысли, но не пытайтесь подражать - это всегда плохо кончается. Это я всё не только в контексте документации говорю.
То что я сказал - это реальный опыт нашей команды, который актуален прямо сейчас ) И меня кстати самого своё рассуждение на некоторые мысли натолкнуло )
Прошу прощения за некоторый сумбур, я торопился, чтобы мысли не потерять. А теперь лень структурировать...