Документация за продукта
Помогнете на потребителите да изпълняват задачите, които приложението ви поддържа
Предоставяйте на потребителите практически ръководства, които обясняват различните етапи от използването на приложението и им помагат да изпълняват задачите си.
Превърнете функционалността на продукта в практически инструкции
- Подгответе обхвата на ръководството
Прегледайте разделите на документацията и предвидената им аудитория.
- Отговорете на въпросите за съдържанието
Уточнете работните процеси и информацията, които ръководството трябва да обясни.
- Следете публичната услуга
Прегледайте напредъка на изграждането и адреса на сайта с документацията.
Обяснете как се използва приложението
Документацията допълва представянето на продукта с практически инструкции. Започнете с първите стъпки, след това преведете потребителите през работните процеси, които приложението действително поддържа.
Конфигурацията на документацията показва дефинициите на разделите и въпросите. Предоставете контекст, който помага да се обясни задачата на езика на потребителя.
Поддържайте ръководството свързано с работещото приложение
Подкрепете първо полезно действие. Ръководството за първи стъпки дава на новите потребители кратък път към продукта. То трябва да обяснява откъде да започнат, каква информация е необходима и кой резултат потвърждава, че задачата е изпълнена.
Обяснете повтарящ се работен процес. Подробното ръководство следва реалните етикети и действия в приложението. Предварителните условия, номерираните стъпки и очакваният резултат помагат на човек да повтори бизнес задача, без да тълкува общо описание на екрана.
Отговорете на общ въпрос. Някои въпроси се отнасят до акаунти, разходи или публикуване, а не до един екран. Разделът с често задавани въпроси дава кратък отговор и води към съответното ръководство, като процедурата остава на едно място, вместо да се дублира в целия сайт.
Поддържайте ръководствата свързани с продукта
Прегледайте документацията след съществена промяна в приложението. Ръководството трябва да използва етикетите и поведението, които потребителите действително виждат.
Документацията работи в собствена публична услуга. Поставете връзка към нея от уебсайта и проверете ръководствата на езиците, които проектът ви публикува.
Помогнете на потребителя да изпълни следващата задача
Практическото ръководство обяснява откъде да се започне, каква информация е необходима и как да се провери резултатът. Стойността му идва от това, че помага на читателя да действа в приложението.
Използвайте свързаните ръководства, за да продължите пътя, когато задачата обхваща няколко области. Прегледайте документацията, когато даден екран се промени, за да останат инструкциите полезни след промяната.
От договорената функционалност до полезна помощ
Подгответе обхвата на ръководството. Прегледайте разделите на документацията и задачите, които те трябва да обяснят. Поддържайте ясни предвидения потребител и поведението на приложението.
Предоставете липсващия контекст. Отговорете на въпросите за предварителните условия, правилата и резултатите. Текстът трябва да използва реалния интерфейс, а не измислени контроли.
Преглед след публикуване и промяна. Следвайте ръководството в приложението, проверете езиците и свързаните с него връзки, след това се върнете към него, когато основната задача се промени.
Направете продукта по-лесен за използване след първото посещение
Предоставете инструкции, които водят до резултат, наред с публичното представяне на това, което прави приложението.
Въпроси за продуктовата документация
Страницата с функция помага на потенциалния клиент да разбере възможността и нейната стойност. Ръководството помага на потребителя да изпълни задачата с реалните контроли, предварителни условия и резултат. Те се допълват.
Инструментите за документация показват дефинициите на разделите и въпросите. Прегледайте задачите, които приложението поддържа, предоставете липсващия контекст и следете напредъка на писането.
Проектът публикува преведените ръководства, налични за неговия обхват. Прегледайте всеки публикуван език, за да запази той пълната процедура и правилните етикети на интерфейса.
След промяна, която засяга задачата, нейните контроли или очаквания резултат. Сравнете текста с работещото приложение, вместо да приемате, че първоначалните инструкции остават валидни.
Справочникът за крайните точки принадлежи на проект с активен, работещ API. Използвайте реалните му операции и действителния справочник; планираните маршрути не са достатъчни, за да се документира използваема интеграция.