Гость
Войти | Профиль | Очистить
Map
Действия ...
Форумы / Управление процессом разработки ИС [игнор отключен] [закрыт для гостей] / Структура документации в ИТ компании / 8 сообщений из 8, страница 1 из 1
20.05.2021, 14:02
    #40071659
Диам
Диам
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Структура документации в ИТ компании
Всем привет.
Озаботился структурой технической документации в компании. Чтобы было удобно находить нужную информацию при анализе, разработке, тестировании, приеме на работу. Сделал вот такую структуру. Покритикуйте.
 


Код: 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.
Общее для всей компании						
	Бизнес-процессы					
		Категории бизнес-процессов			
			Бизнес-процесс			
	Используемые технологии					
		Перечень ЯП/Платформ				
	Как вносить изменения в документацию (как написать инструкцию)					
						
Отделы						
	Отдел (1С / CRM / Сервисы / Веб / Б-А / Тестирование / Админы / ТП..)					
		Сотрудникам (Прием на работу)				
			План вхождения в должность			
			Требования к должностям			
			Грейды			
			Система мотивации			
			Обязательное к прочтению (ссылки с кратким описанием на статьи или книги)			
		Стандарты отдела				
			Принципы отдела			
			Настройка рабочего места			
			Стандарты кодирования			
			Требования к разработке интерфейсов пользователя			
			Требования к разработке бэка (наши практики внутри отдела)			
			Требования к разработке бэка (ссылки на наши практики взаимодействия между тделами/платформами)			
				Требования для соблюдения Информационной безопасности			
		Инструменты				
			MS SQL, TFS, Git, Selenium и т.д.			
	Отдел (1С / CRM / Сервисы / Веб / Б-А / Тестирование / Админы / ТП..)					
Платформы						
	Взаимодействие между платформами					
		Общие требования к разработке бэка (наши практики взаимодействия между отделами/платформами)				
		Описание взаимодействия Платформа-Платформа (1С-Битрикс, 1С-MS SQL, MS SQL - Сервисы, МП - MS SQL)				
		Описание взаимодействия Платформа-Платформа (1С-Битрикс, 1С-MS SQL, MS SQL - Сервисы, МП - MS SQL)				
	Внеплатформенные программы (нет явной принадлежности к отделу/платформе)					
		Программный продукт 1 (сторонняя программа, участвующая в основном БП компании)				
			Кто сопровождает (назначенный владелец)			
			Сторонняя документация (ссылки на внешнюю документацию)			
		Программный продукт 2...				
	Платформа (1С / MSA + MS SQL / C# / Сайт / МП / Портал)					
		Программный продукт 1				
			Сторонняя документация (ссылки на внешнюю документацию)			
			Функциональный домен (Расчетный движок)			
				Функционал (Реструктуризация)		
					Процесс (Добавление заявления, Одобрение заявления и т.д.)	
						Тест-планы
		Программный продукт 2				
	Платформа (1С / MSA + MS SQL / C# / Сайт / МП / Портал)					
						
-----------------------------------							
Для Б.А.:							
	ТЗ должно содержать ссылку на Бизнес-процесс. Если в системе документации его нет, то его надо создать, хотя бы и пустой, с одним блоком.						
	ТЗ должно содержать ссылку на Функциональный домен - Функционал. Если в системе документации его нет, то его надо создать в документации						
							
Для тестировщика:							
	Тестировщик при необходимости должен создать тест-план, внести его в документацию (Тест-план)
...
Рейтинг: 0 / 0
| Ответить | Цитировать | Написать  
20.05.2021, 15:46
    #40071707
hVostt
hVostt
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Структура документации в ИТ компании
Диам,

Что-то можно выкинуть?
...
Рейтинг: 0 / 0
| Ответить | Цитировать | Написать  
20.05.2021, 16:24
    #40071725
Диам
Диам
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Структура документации в ИТ компании
hVostt
Диам,
Что-то можно выкинуть?


Составлял эту структуру исходя из учета, что ею будут постоянно пользоваться. Т.к. та часть, которая останется без потребителя, быстро перестанет обновляться и потеряет актуальность.

Возможно пункт из 4-й строки "Используемые технологии... Перечень ЯП/Платформ" - лишний. Для кого он? Для проходящего мимо... )

Что можете предложить в дополнение?
...
Рейтинг: 0 / 0
| Ответить | Цитировать | Написать  
20.05.2021, 18:28
    #40071755
ЮВ
ЮВ
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Структура документации в ИТ компании
Диам

Что можете предложить в дополнение?

Вот вы разработали набор документов.
Если поручите написать эти документы, например, 10 разным лицам, получите 10 разных вариантов оформления (форматирования) текста, таблиц, рисунков, формата документа (HTML, PDF, Word ) и т.п.
В целях единообразия должен быть документ типа 'Корпоративный стандарт оформления документации'.
...
Рейтинг: 0 / 0
| Ответить | Цитировать | Написать  
20.05.2021, 18:35
    #40071756
fkfka
fkfka
Гость
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Структура документации в ИТ компании
Заведи любую вики и сваливай все туда. Потом по мере накопления будешь уже как-то упорядочивать. Иначе у тебя за созданием структуры до наполнения этой структуры содержанием так никогда и не дойдет.
...
Рейтинг: 0 / 0
| Ответить | Цитировать | Написать  
20.05.2021, 18:47
    #40071760
Диам
Диам
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Структура документации в ИТ компании
ЮВ
Диам

Что можете предложить в дополнение?

Вот вы разработали набор документов.
Если поручите написать эти документы, например, 10 разным лицам, получите 10 разных вариантов оформления (форматирования) текста, таблиц, рисунков, формата документа (HTML, PDF, Word ) и т.п.
В целях единообразия должен быть документ типа 'Корпоративный стандарт оформления документации'.


За это как раз седьмая строчка отвечает. Дополню. Спасибо.
>>Как вносить изменения в документацию (как написать инструкцию)


Ну и заливка идет через ГИТ, а там её проверяем на соответствие стандарту.
...
Рейтинг: 0 / 0
| Ответить | Цитировать | Написать  
20.05.2021, 18:48
    #40071761
Диам
Диам
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Структура документации в ИТ компании
fkfka
Заведи любую вики и сваливай все туда. Потом по мере накопления будешь уже как-то упорядочивать. Иначе у тебя за созданием структуры до наполнения этой структуры содержанием так никогда и не дойдет.


Мы уже так и делаем. Сваливаем вроде и не в кучу, но структуры нет. Потому и озаботился.
...
Рейтинг: 0 / 0
| Ответить | Цитировать | Написать  
23.05.2021, 23:14
    #40072341
hVostt
hVostt
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Структура документации в ИТ компании
Диам
hVostt
Диам,
Что-то можно выкинуть?


Составлял эту структуру исходя из учета, что ею будут постоянно пользоваться. Т.к. та часть, которая останется без потребителя, быстро перестанет обновляться и потеряет актуальность.

Возможно пункт из 4-й строки "Используемые технологии... Перечень ЯП/Платформ" - лишний. Для кого он? Для проходящего мимо... )

Что можете предложить в дополнение?


Когда готовите документацию, автоматически ставьте себя на место человека, который будет её читать. Сколько времени на чтение понадобится? Как вы думаете, вообще среднестатический человек способ усвоить и запомнить такой объём информации? Каким образом это вообще будет работать? Точнее даже в каком контексте и каким образом будет регламентироваться?

Вообще, разработать хорошую таксономию это довольно серьёзный труд. Самое первое, что напрашивается, это иерархическая структура, каталог документов. Что в принципе не плохо. Однако в разных плоскостях структура будет совершенно разной.

Например, первые шаги новичка в компании, для него потребуются одни документы, те же процедуры организованы по направлениям. А потом, смешивания орг. процессов и технических -- тоже выглядит как проблема, так как тех. процессы могут меняться быстрее орг. Или наоборот.

В общем, вопросов много, ответов мало. Правильного ответа не существует. Самого лучшего в принципе тоже.

Именно поэтому в мире популярен формат вики без какой-либо иерархии. Вики хороша системой поиска, и хорошо работает когда всё обмазано линками.
...
Рейтинг: 0 / 0
| Ответить | Цитировать | Написать  
Форумы / Управление процессом разработки ИС [игнор отключен] [закрыт для гостей] / Структура документации в ИТ компании / 8 сообщений из 8, страница 1 из 1
Целевая тема:
Создать новую тему:
Автор:
Найденые пользователи ...
Разблокировать пользователей ...
Читали тему (0):
Читали форум (0):
Пользователи онлайн (0):
Польз. соглашение
созд. / загр.: 262ms
Закрыть
Start [/forum/topic.php?fid=37&mobile=1&tid=1555230]:
 0ms
get settings:
 16ms
get forum list:
 8ms
check forum access:
 1ms
check topic access:
 1ms
track hit:
 67ms
get topic data:
 5ms
get forum data:
 1ms
get page messages:
 155ms
get tp. blocked users:
 0ms
others: 8ms
total:  262ms
x
x
Закрыть


Просмотр
0 / 0
Close
Debug Console [Select Text]