Програмистите и техническите автори създават заедно софтуерния продукт

Каналът за обратна връзка с потребителите играе важна роля за подобряване на вече написаната техническа документация за софтуерния продукт (снимка: SAP)

Техническата документация е част от софтуерния продукт, като още от началния етап на създаването му програмистите и техническите автори работят заедно. Изключително важна роля играе и каналът за обратна връзка с потребителите, чрез който се подобрява вече написаната документация, по думите на специалисти от SAP Labs България.

Екатерина Митова и Димитър Симов ще разкажат пред аудиторията на ETC 2016 как работи екипът за техническа документация на SAP HANA Cloud Platform и в частност – услугата за обратна връзка, какви са предизвикателствата по нейното внедряване, интеграция и функциониране. Ето какво споделиха те в навечерието на конференцията за техническа комуникация, която ще се проведе на 2 и 3 юни в София.

„Колкото по-сплотено работят различните специалисти по даден продукт или функционалност, толкова по-качествено е свършена работата”, казва Екатерина Митова

Какво е мястото на отдела по техническа документация и в частност на канала за обратна връзка с потребителите в голяма софтуерна компания като SAP? Къде се пресичат отговорностите на отдела за техническа документация с тези на отдела за поддръжка, например?

Техническата документация в SAP е част от продукта. Не може да бъде пусната нова функционалност, без  да е добре описана. За да стане това възможно, екипите от програмисти и техническите автори работят заедно още от най-начален етап на новия продукт или функционалност. Заедно навлизат в нови материи, отново заедно описват началните дизайн документи, а след това докато програмистите работят върху кода и тестовете, авторите описват функционалността за крайните потребители. Използваме Agile (или още гъвкав) процес. Виждаме се всеки ден, за да знае всеки кой до къде е стигнал и има ли някакви промени. Крайният срок за пускане на функционалността и на документацията е един и същ за всички, което значи, че продуктът и документацията стават готови едновременно.

Каналът за обратна връзка играе важна роля за подобряване на вече написаната документация. Всеки ден получаваме коментари от клиенти, събираме ги, обсъждаме ги с програмистите и заедно преценяваме кое как да подобрим. Дори и информацията, която получаваме от коментарите, невинаги да е достатъчно пълна и ясна, пак ни носи знак, че нещо не е наред и може да бъде описано по-добре. Или пък ако обратната връзка е положителна, разбираме, че сме се справили добре.

Отделите по поддръжка използват документацията, за да помагат на клиентите. Случва се колегите от поддръжката също да коментират даден документ и да изпращат обратна връзка като използват същия канал.

Могат ли специалистите по техническа документация да влияят върху развитието на самия продукт, стъпвайки на безценната обратна връзка, която получават от клиентите? Как взаимодействате със софтуерните архитекти?

Да, определено могат. При получаването на обратна връзка, в зависимост от самия коментар, промяната се обсъжда с архитект или отговорник за продукта. Това може да доведе до промяна в интерфейса, в текстовете и дори във функционалността.

„Знаем си, че примерите са важни в документацията и се стремим да предоставяме такива”, споделя Димитър Симов

Ефективната работа на специалистите по техническа документация вероятно спестява главоболия на екипа по техническа поддръжка. Така ли е наистина, какво показват вашите наблюдения?

Със сигурност документите, които авторите пишат, помагат на екипите по поддръжка. Всъщност, колегите от поддръжката са най-добрите читатели на документацията. Документацията помага и на самите програмисти, които постоянно четат и търсят информация за компоненти, свързани пряко с текущите им задачи. Колкото по-сплотено работят различните специалисти по даден продукт или функционалност, толкова по-качествено е свършена работата.

В чисто технологичен аспект, как е организирана системата за обратна връзка в документацията на SAP HANA Cloud Platform? С какви възможности разполагат потребителите да задават своите въпроси и да правят препоръки, от една страна, и какви инструменти използва отделът по техническа документация, за да обработва ефективно постъпващата информация и да дава отговори?

Обратната връзка събираме анонимно чрез нарочна форма, достъпна във всяка страница на документацията. Там потребителите могат да напишат каквото пожелаят. Правят го. Получаваме препоръки, похвали, оплаквания, критики, идеи…

Така потребителите имат възможност да коментират съвсем точно съответната статия. Формата е много удобна и за колегите програмисти, тестери и поддръжка. Често им е по-лесно да пуснат коментар направо в документацията, отколкото да го направят в системата ни за бъгове.

Обратната връзка се събира анонимно чрез форма, достъпна във всяка страница на документацията

Постъпващата обратна връзка се събира в база, откъдето се разпределя по направления. Имаме определен процес, през който минава получената обратна връзка: преценява се дали изисква действие, назначава се отговорник, преминава се през обсъждане ако е необходимо, правят се нужните промени в документацията, следва проверка и пускане на живо и накрая, ако е подходящо, се обявява на потребителите, че е направена промяна след тяхна обратна връзка.

Формата за обратна връзка не е канал за поддръжка. Информацията се събира анонимно и нямаме възможност да отговаряме пряко. Потребителите разбират това и много рядко пускат коментари, които изискват реакция от поддръжката.

Бихте ли разкрили някои по-интересни случаи на отзиви от потребителите, които са ви изненадали, променили са разбирането ви за професията, а защо не и начина на работа и общуване с клиентите?

Коментари, които чак толкова да разклатят разбиранията ни и начина ни на работа, нямаме. Все пак ето няколко интересни попадения:

Още докато пуснахме канала, получихме коментар:

Здрасти,

Яко! Благодаря, че предоставихте този канал за обратна връзка!

Но моля, направете всичката обратна връзка от потребителите си публична. Така човек ще може да следи как САП откликват.

И така, очаквам обществен сайт, където мога да видя обратната връзка и реакцията на САП 🙂

Вече бяхме мислили по въпроса как да споделяме какво сме адресирали. Човекът ни изпревари. Скоро след това пуснахме страница в документацията, където описваме какви промени сме направили вследствие получена обратна връзка.

Други интересни случаи касаят примерите в документацията. Коментарите, които говорят за примери, са около 7-8% от всички коментари. Най-често хората казват, че им липсва пример или че не разбират дадения пример. Знаем си, че примерите са важни в документацията и се стремим да предоставяме такива. Тези коментари ни показват, че трябва да сме още по-внимателни с подбора и описването на примерите.

Изненадващо за нас се оказа колко много са положителните коментари. Около 25% от обратната връзка, в която потребителите са написали коментар, е положителна. Пишат ни обикновено съвсем кратки неща като „Благодаря”, „Много полезно”, „Много добре”, та дори и „Отлично”.

Още едно интересно наблюдение е, че има зависимост между посещаемостта на дадена страница и коментарите, които получава, но не непременно най-посещаваните са и най-коментираните. Все още изследваме зависимостите. Заповядайте на 2 юни в 15:00 в зала Витоша на Холидей Ин в Бизнес парк София, за да научите повече.