|
Структура документации в ИТ компании
|
|||
---|---|---|---|
#18+
Всем привет. Озаботился структурой технической документации в компании. Чтобы было удобно находить нужную информацию при анализе, разработке, тестировании, приеме на работу. Сделал вот такую структуру. Покритикуйте. Код: plaintext 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. 11. 12. 13. 14. 15. 16. 17. 18. 19. 20. 21. 22. 23. 24. 25. 26. 27. 28. 29. 30. 31. 32. 33. 34. 35. 36. 37. 38. 39. 40. 41. 42. 43. 44. 45. 46. 47. 48. 49. 50. 51. 52. 53.
... |
|||
:
Нравится:
Не нравится:
|
|||
20.05.2021, 14:02 |
|
Структура документации в ИТ компании
|
|||
---|---|---|---|
#18+
Диам, Что-то можно выкинуть? ... |
|||
:
Нравится:
Не нравится:
|
|||
20.05.2021, 15:46 |
|
Структура документации в ИТ компании
|
|||
---|---|---|---|
#18+
hVostt Диам, Что-то можно выкинуть? Составлял эту структуру исходя из учета, что ею будут постоянно пользоваться. Т.к. та часть, которая останется без потребителя, быстро перестанет обновляться и потеряет актуальность. Возможно пункт из 4-й строки "Используемые технологии... Перечень ЯП/Платформ" - лишний. Для кого он? Для проходящего мимо... ) Что можете предложить в дополнение? ... |
|||
:
Нравится:
Не нравится:
|
|||
20.05.2021, 16:24 |
|
Структура документации в ИТ компании
|
|||
---|---|---|---|
#18+
Диам Что можете предложить в дополнение? Вот вы разработали набор документов. Если поручите написать эти документы, например, 10 разным лицам, получите 10 разных вариантов оформления (форматирования) текста, таблиц, рисунков, формата документа (HTML, PDF, Word ) и т.п. В целях единообразия должен быть документ типа 'Корпоративный стандарт оформления документации'. ... |
|||
:
Нравится:
Не нравится:
|
|||
20.05.2021, 18:28 |
|
Структура документации в ИТ компании
|
|||
---|---|---|---|
#18+
Заведи любую вики и сваливай все туда. Потом по мере накопления будешь уже как-то упорядочивать. Иначе у тебя за созданием структуры до наполнения этой структуры содержанием так никогда и не дойдет. ... |
|||
:
Нравится:
Не нравится:
|
|||
20.05.2021, 18:35 |
|
Структура документации в ИТ компании
|
|||
---|---|---|---|
#18+
ЮВ Диам Что можете предложить в дополнение? Вот вы разработали набор документов. Если поручите написать эти документы, например, 10 разным лицам, получите 10 разных вариантов оформления (форматирования) текста, таблиц, рисунков, формата документа (HTML, PDF, Word ) и т.п. В целях единообразия должен быть документ типа 'Корпоративный стандарт оформления документации'. За это как раз седьмая строчка отвечает. Дополню. Спасибо. >>Как вносить изменения в документацию (как написать инструкцию) Ну и заливка идет через ГИТ, а там её проверяем на соответствие стандарту. ... |
|||
:
Нравится:
Не нравится:
|
|||
20.05.2021, 18:47 |
|
Структура документации в ИТ компании
|
|||
---|---|---|---|
#18+
fkfka Заведи любую вики и сваливай все туда. Потом по мере накопления будешь уже как-то упорядочивать. Иначе у тебя за созданием структуры до наполнения этой структуры содержанием так никогда и не дойдет. Мы уже так и делаем. Сваливаем вроде и не в кучу, но структуры нет. Потому и озаботился. ... |
|||
:
Нравится:
Не нравится:
|
|||
20.05.2021, 18:48 |
|
Структура документации в ИТ компании
|
|||
---|---|---|---|
#18+
Диам hVostt Диам, Что-то можно выкинуть? Составлял эту структуру исходя из учета, что ею будут постоянно пользоваться. Т.к. та часть, которая останется без потребителя, быстро перестанет обновляться и потеряет актуальность. Возможно пункт из 4-й строки "Используемые технологии... Перечень ЯП/Платформ" - лишний. Для кого он? Для проходящего мимо... ) Что можете предложить в дополнение? Когда готовите документацию, автоматически ставьте себя на место человека, который будет её читать. Сколько времени на чтение понадобится? Как вы думаете, вообще среднестатический человек способ усвоить и запомнить такой объём информации? Каким образом это вообще будет работать? Точнее даже в каком контексте и каким образом будет регламентироваться? Вообще, разработать хорошую таксономию это довольно серьёзный труд. Самое первое, что напрашивается, это иерархическая структура, каталог документов. Что в принципе не плохо. Однако в разных плоскостях структура будет совершенно разной. Например, первые шаги новичка в компании, для него потребуются одни документы, те же процедуры организованы по направлениям. А потом, смешивания орг. процессов и технических -- тоже выглядит как проблема, так как тех. процессы могут меняться быстрее орг. Или наоборот. В общем, вопросов много, ответов мало. Правильного ответа не существует. Самого лучшего в принципе тоже. Именно поэтому в мире популярен формат вики без какой-либо иерархии. Вики хороша системой поиска, и хорошо работает когда всё обмазано линками. ... |
|||
:
Нравится:
Не нравится:
|
|||
23.05.2021, 23:14 |
|
|
Start [/forum/topic.php?fid=37&tid=1555230]: |
0ms |
get settings: |
34ms |
get forum list: |
11ms |
check forum access: |
9ms |
check topic access: |
9ms |
track hit: |
53ms |
get topic data: |
23ms |
get forum data: |
6ms |
get page messages: |
365ms |
get tp. blocked users: |
2ms |
others: | 195ms |
total: | 707ms |
0 / 0 |