Что значит документация для СДК пройект? Как это сделать?

swift
ios

#1

Здраствуйтe,

Можеть кто-нибудь мне сказать что это Documentation of the SDK project (для iOS)? Я новичок и не знаю как мне это надо сделать.

Спасибо за ваш помош


#2

А можно увидеть полное предложение задачи?
Я пока только понимаю что вам нужно сделать документацию, либо достать ее.


#3

Проблема в том, что я еще ничего не получил. У меня нет доступа ни к коду, ни к проекту. Я знаю только название приложения. Я только что приступил к работе в качестве младшего разработчика.

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

Не могли бы вы поделиться со мной ссылкой, где я могу прочитать, как сделать документацию для iOS SDK? Что мне для этого нужно? и вообще что это означает

Спасибо


#4

Получается вам нужно написать инструкцию как использовать конкретную библиотеку. Но как ее писать не зная что это за библиотека…
Я бы лучше спросил что конкретно нужно делать. Что это за SDK.
Как можно писать документацию к продукту не зная что это за продукт.


#5

И когда я пишу. Должен ли я писать документацию в виде кода (c XCode используя swift) или документация - это просто readme информация о том, как использовать приложение и что это приложение делает? Потому что я никогда не писал документацию. Я работал только 1 год в качестве младшего iOS разработчика и в этой компании я только начал работать 5 дней назад.


#6

Уточните у старшего что конкретно нужно сделать.
А еще лучше запросите ТЗ.