Добър начин за развиване на уменията за писане е провеждането на writing sprint. „Writing sprint“-овете не се случват само в техническата сфера, използват ги и автори на художествена или академична литература. Най-общо казано, това е време, което група хора отделят с една единствена цел – да напишат нещо заедно. Техническите writing sprints на tekom България са събития, на които група автори на техническа документация се събират заедно с програмисти или експерти, за да напишат заедно хелп, тюториъл, или да подобрят API документацията на някой open source проект.

Групата, която участва в един writing sprint може да е от 3 до 12 души. Ако има повече от 12 желаещи, те се разделят на по-малки групи, защото основен елемент на „writing sprint“-a e колаборацията, която се изразява в това да пишем и ревюираме текста заедно. Това се получава много по-лесно в малка група, където е по-спокойно да изкажеш своите идеи и да чуеш идеите на другите. Разбира се, основната част от времето отива за писане, но четенето и обсъждането на написаното са всъщност важен и необичаен елемент в спринта. Писането по време на writing sprint далеч не е самотно занимание.  Не е задължително обаче участниците да са физически на едно и също място, понякога групи от различни страни и локации се включват виртуално в общ writing sprint.

Един writing sprint продължава ден, много рядко два, затова е важно да има конкретна и постижима цел, нещо, което да е готово (или почти готово) в края на спринта. По това „writing spint“-a прилича на hackaton, но готовия продукт в края а текст, вместо код.

В зависимост от целта на спринта, той може да използва различни методи за писане. Например, на writing sprint-а, който направихме за проекта TINUSAUR (https://tinusaur.org/) използвахме някои от методите на design thinking. Този подход беше подходящ в случая, защото целта беше да измислим, дизайнем и напишем два тюториъла съвсем от нулата. На международния Pandas Doc Sprint (https://python-sprints.github.io/pandas/), в който се включихме, целта беше да подобрим Pandas API рефърънс документацията. Затова трябваше да се фокусираме повече върху стандартите за писане на АPI рефърънс и добри примери.

Много важен елемент за добрия writing sprint е да си изберете човек, който да придвижва организацията преди самия спринт и по време на спринта. Всички организационни детайли трябва да се съобщят на участниците преди деня на спринта. Трябва да им изпратите и материалите, които да ги запознаят с проекта предварително. В деня на спринта обикновено няма достатъчно време да навлязат във всички детайли и е добре да знаят предварително кой е проекта, каква е целта му, как ще протече работата. Обикновено се създава и онлайн канал за комуникация, например gitter, където участниците могат да задават въпроси, да постват и обсъждат откъси от текста, да си говорят за шоколад (когато са блокирали при писането).

Предизвикателството на writing sprint-a е, че трябва много бързо да навлезеш в напълно нова материя и самото писане е доста интензивно. За някои хора е трудно да пишат колаборативно, понеже това не се случва много често в ежедневната ни работа. Но в същото време е доста по-забавно да пишеш заедно с други хора, да можеш директно да задаваш въпроси на програмистите или експертите, които са създали Open source проекта. Научаваш много неща за проекта, научаваш и много нови неща за самото писане. Освен това правиш нещо смислено, като допринасяш с времето и труда си за Open source проект, който е полезен за много хора.


За нас: 

tekom Europe е най-голямата професионална организация за техническа комуникация в Европа. Създадена е през 2013 г. в Германия, като сред основните ѝ цели е защита на интересите на общността от автори на техническа документация в Европа, подпомагане на нейните членове посредством обучение и търсене на подходяща за тях работа в рамките на ЕС. Организацията обединява над 9000 професионалисти от общо 12 държави, сред които и България. tekom България е част от tekom Europe от 2015 г. Екипът на българското подразделение организира ежегодно редица информационни събития за хората, които се интересуват от тази сфера, сред които конференцията за технически комуникации Evolution of Technical Communication, хакатон под формата на Writing sprint, събитието ориентирано към жените в професията Women in Tech Comm, неформалната конференция Bar Camp, както и няколко Road Shows, целящи да популяризират професията в градове различни от София.  Едно от нещата, които правим в tekom България, е да помагаме на авторите на техническа документация да развиват своите умения как да намират, анализират и пишат информация, която да ти помогне да разбереш и използваш някакъв нов софтуер, устройство или технология.

Share This