Size: a a a

technicalwriters

2020 May 15

N

Noname in technicalwriters
а это как то имеет отношение к свящям(relationshi)между enitites?
источник

L

Lex in technicalwriters
А можете дать контекст?
источник

N

Noname in technicalwriters
Lex
А можете дать контекст?
можно я поделюсь ссылкой на курс,на конкретный урок,который я смотрю.Там объясняют,что такое consistency.Мне скинуть сюда или вам в личку?
источник

L

Lex in technicalwriters
Давайте в личку
источник

L

Lex in technicalwriters
источник

N

Noname in technicalwriters
У меня ещё один вопрос:чтобы грамотно документировать API,нужно:1.БД,общее понимание (таблицы,связи,первичные ключи, foreign ключи,связи).2.знание HTTP, на основе этих знаний придет и понимание REST API.
источник

N

Noname in technicalwriters
Noname
У меня ещё один вопрос:чтобы грамотно документировать API,нужно:1.БД,общее понимание (таблицы,связи,первичные ключи, foreign ключи,связи).2.знание HTTP, на основе этих знаний придет и понимание REST API.
Дополните пожалуйста список🙏
источник

N

Noname in technicalwriters
Моя цель: используя имеющие навыки классического БА научиться грамотно (хотя бы сносно на первом этапе) документировать API
источник

A

Andrey in technicalwriters
3. Грамотный язык
4. Наличие примеров хорошо описанных чужих API
источник

KU

Kateryna Ushakova in technicalwriters
Noname
У меня ещё один вопрос:чтобы грамотно документировать API,нужно:1.БД,общее понимание (таблицы,связи,первичные ключи, foreign ключи,связи).2.знание HTTP, на основе этих знаний придет и понимание REST API.
Уметь читать код и задавать вопросы разрабам.
Понимать как разложить архитектуру документа, если нет автогенерации (и не предвидится в обозримом будущем).
Самостоятельно отправлять запросы через тот же postman.
источник

N

Noname in technicalwriters
Kateryna Ushakova
Уметь читать код и задавать вопросы разрабам.
Понимать как разложить архитектуру документа, если нет автогенерации (и не предвидится в обозримом будущем).
Самостоятельно отправлять запросы через тот же postman.
Что значит: разложить архитектуру документа?Есть пример спецификации по конечным точкам от Заказчика.Есть настроенный postman с нужным environment.Запросы отправлять умею,умею анализировать респонзы,понимаю разницу в методах,понимаю параметры запроса и параметры ответа
источник

N

Noname in technicalwriters
Andrey
3. Грамотный язык
4. Наличие примеров хорошо описанных чужих API
Большое спасибо!Опыт БА имеется.Более менее грамотный язык тоже(в постоянном самосовершенствовании)
источник

KU

Kateryna Ushakova in technicalwriters
Noname
Что значит: разложить архитектуру документа?Есть пример спецификации по конечным точкам от Заказчика.Есть настроенный postman с нужным environment.Запросы отправлять умею,умею анализировать респонзы,понимаю разницу в методах,понимаю параметры запроса и параметры ответа
Очень часто в документации апи приходится переиспользовать хотя бы описание параметров. Если это делать через «копировать-вставить», то поддержка такого документа превратится в очень сложное занятие.
источник

N

Noname in technicalwriters
Kateryna Ushakova
Очень часто в документации апи приходится переиспользовать хотя бы описание параметров. Если это делать через «копировать-вставить», то поддержка такого документа превратится в очень сложное занятие.
Можно вопрос:есть в документе от Заказчика раздел :общие параметры(page size,page number и т.д).Они всегда будут одинаковые для всех конечных точек?
источник

N

Noname in technicalwriters
Noname
Можно вопрос:есть в документе от Заказчика раздел :общие параметры(page size,page number и т.д).Они всегда будут одинаковые для всех конечных точек?
Я могу их переиспользовать для другой спеки?Это нормально?
источник

KU

Kateryna Ushakova in technicalwriters
Noname
Можно вопрос:есть в документе от Заказчика раздел :общие параметры(page size,page number и т.д).Они всегда будут одинаковые для всех конечных точек?
Это лучше уточнить у заказчика) бывает, что разные группы методов пишут разные группы разработки и получаются разные названия параметров. Хочется верить, что это не очень частый случай, но лучше уточнить есть ли в компании какие-то договоренности по названию параметров
источник

N

Noname in technicalwriters
@ushkatia а можно ещё один вопрос.Вот мне выше объяснили что такое вопрос:как это требование правильно описать в спеке?
источник

N

Noname in technicalwriters
Noname
@ushkatia а можно ещё один вопрос.Вот мне выше объяснили что такое вопрос:как это требование правильно описать в спеке?
Есть разработанная техлидом логическая модель.Отношения между сущностями проставлены.Мне как ТП нужно это отдельным требованием описывать?
источник

N

Noname in technicalwriters
Извините,если вопросы тупые🙈 я только учусь
источник

KU

Kateryna Ushakova in technicalwriters
Noname
Есть разработанная техлидом логическая модель.Отношения между сущностями проставлены.Мне как ТП нужно это отдельным требованием описывать?
Лучше это тоже уточнить у заказчика) если считаете важным — описывайте, конечно. Тем более если нет четкого списка что должно быть в конечном документе — вся информация на ваше усмотрение. Но когда сомневаетесь — лучше уточнить у заказчика.
источник