Пишем спецификации

Инструменти за събиране1)Двигател. MediaWikiИма много уики машини. Не бих си позволил да кажа, че едното е по-добро от другото. Избрах правилния за нас. На първо място, това е безплатно. Отивайки в уикито, не бях 100% сигурен, че това ще е окончателното решение, така че не исках да рискувам да купя някаква търговска система. Още повече, че по това време за мен (малко преувеличавам) всички уикита изглеждаха еднакви. Второ, езикът за изпълнение. PHP/MySQL. Ние вече имахме такива сайтове и такива специалисти и бяхме готови, ако трябва, да превъртим нещо. Трето, голям брой всякакви разширения. И накрая, едно голямо име. Надявах се, че този двигател ще бъде достатъчно надежден, тъй като дърпа Wikipedia.

2)Редактор. WikEd + FCKEditorРазбира се, исках visivig. Всяка нова система ще бъде посрещната враждебно, ако трябва да промените навиците си, за да работите с нея. В случая такъв навик беше работата с текстове. Всички знаеха как да работят в Word. И не исках да принуждавам анализаторите да учат всякакви езици за маркиране (макар и много прости, но не се нуждаят от тях, за да вършат основната си работа), не исках. За програмистите бях спокоен. След html, wiki маркирането е просто приказка.

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

5)UML. PlantUMLС помощта на специален синтаксис UML диаграмите могат да бъдат "начертани" директно в текста на wiki страницата. И тогава ще бъде изграден чертеж според това текстово описание.

пишем
Поддържат се всички видове диаграми (за разлика от много други безплатнипрограми, които познават само диаграми на класове и последователности). Това със сигурност не е сериозен инструмент за проектиране на UML с генериране на изходен код. Но това е достатъчно, за да илюстрира дизайнерските решения. Една снимка струва сто думи. Неочаквано за мен, с появата на това разширение UML се наложи в нашата компания. Преди това имаше опити да се рисуват различни диаграми във Visio. Но това беше направено някак насила, без удоволствие. Мисля, че защото визията е твърде строга и изискваща. А PlantUML, напротив, прощава много, опитва се да отгатне какво има предвид. И затова е удоволствие да се работи с него. Колегите ми са сменени. Всички изведнъж се влюбиха в UML, което ме прави изключително щастлив.

6)Оцветяване на синтаксиса. SyntaxHighlight GeSHiВ много спецификации, заедно с диаграми, ние веднага скицираме някакъв код. Искам да изглежда ясно и познато, както в средата за разработка. Разширението за подчертаване на синтаксиса ни помага с това. Предлага се с поддръжка за куп езици, ние не използваме всички. За моя любим Delphi промених малко настройките, за да изглежда по-скоро като IDE.

ЗаключенияКогато е настроено правилно, wiki се превръща в чудесен инструмент за писане (съхранение/извличане/четене) на спецификации. Една такава обикновена тетрадка + молив, в която да пишеш при всяка възможност. Това се опитваме да правим. Ако знаете нещо, пуснете го в уикито възможно най-скоро, преди да сте забравили.