Безплатно: Как да създадете шаблони за Confluence

Безплатно: Как да създадете шаблони за Confluence

Шаблоните в Confluence ускоряват документацията, като предоставят на всеки екип доказана отправна точка. Използвайте това ръководство, за да създадете шаблони в Confluence, които осигуряват последователност, спестяват време и стандартизират знанията във вашата организация.

Шаблоните в Confluence ускоряват документацията, като предоставят на всеки екип доказана отправна точка. Използвайте това ръководство, за да създадете шаблони в Confluence, които осигуряват последователност, спестяват време и стандартизират знанията във вашата организация.

Използвайте този шаблон

Използвайте този шаблон

Confluence е една от най-използваните бази знания в света - а страхотните шаблони за Confluence са това, което я прави мащабируема. С Trupeer можете да спестите часове от дизайна на шаблони за Confluence, като започнете с нашето безплатно ръководство и библиотека с шаблони, персонализирате ги с вашите brand guidelines и превърнете страниците в Confluence във видео обиколки, които вдъхват живот на документацията.

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

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

Какво представляват шаблоните за Confluence

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

Съществуват четири вида и ако знаете с кой работите, спестявате объркване.

Тип

Създаден от

Наличен в

Редактиран от вас

Системни шаблони

Atlassian, вградени

Навсякъде

Не

Blueprints

Atlassian или приложения

Навсякъде

Не директно

Глобални шаблони

Вашите администратори

Всички пространства

Да, с администраторски права

Шаблони за пространство

Администратори на пространството

Едно пространство

Да

По-голямата част от това, което един екип изгражда, ще бъдат шаблони за пространство. Глобалните шаблони са за неща, от които се нуждае всяко пространство, като формат за бележки от среща или запис на решение.

Confluence blueprints vs templates

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

A template е структура на страница. Създавате страница от нея и получавате тази структура.

A blueprint е template плюс поведение. Blueprints могат да ви подканят с диалог, преди да бъде създадена страницата, да генерират повече от една страница, да създадат индексна страница, която изброява всички страници от този тип, и да прилагат логика, която обикновеният template не може. Примерите, които всички познават, са meeting notes и decision blueprints на Atlassian, а индексната страница, която те поддържат, е частта, която template не може да репликира.

Практическите последици: можете да създавате и редактирате templates сами, но не можете да изградите blueprint без разработка на приложение. Ако искате поведение, подобно на blueprint, без разработка, обичайните подходи са template в комбинация с макроса Create from Template на родителска страница, плюс отчет за page properties, за да се изгради индексът.

Ако някой поиска „a blueprint“, обикновено има предвид, че иска индексната страница.

Глобален или шаблон за пространство?

Решете, преди да изградите, защото преместването по-късно означава да го пресъздадете.

Глобален, когато всяко пространство има нужда от него, когато има значение последователността в организацията, или когато подкрепя процес в цялата компания. Бележки от срещи, записи на решения, доклади за инциденти, проектни харти.

За пространство, когато е специфично за начина на работа на един екип, когато ще се променя често, или когато все още тествате дали е полезно. Повечето шаблони започват оттук и някои „порастват“.

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

Как да персонализирате този шаблон в Trupeer

Стъпка 1: Отворете секцията Templates

Отидете до секцията Templates от основната навигация.

Open the Templates section in Trupeer

Стъпка 2: Изберете и отворете шаблон

Кликнете върху всеки шаблон, с който искате да работите, за да го отворите.

Select and open a template in Trupeer

Стъпка 3: Разгънете изгледа на шаблона

Ако е нужно, разгънете изгледа на шаблона, за да видите пълното оформление и детайлите ясно.

Expand the template view in Trupeer

Стъпка 4: Редактирайте шаблона

Кликнете върху Edit, за да започнете да променяте избрания шаблон.

Edit the template in Trupeer

В редактора можете да:

  • Добавите нови секции

  • Дефинирате или актуализирате правила за форматиране

  • Добавите лого и да коригирате позицията му и свързаните настройки

Стъпка 5: Запазете персонализирания си шаблон

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

Save your customized template in Trupeer

Стъпка 6: Преглед и фина настройка на шаблона

Когато искате да видите как изглежда вашият персонализиран шаблон, отворете Preview.

Preview and fine-tune the template in Trupeer

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

С това ръководство за шаблони за Confluence можете да:

  • Спестите часове от документация: Използвайте доказани шаблонни модели за Confluence вместо да започвате от нулата.

  • Постигнете последователност: Всеки екип използва една и съща структура за подобни документи.

  • Останете в бранд: Приложете логото, шрифтовете и цветовете си с brand kit-а на Trupeer.

  • Покрийте всеки сценарий: Шаблони за срещи, проекти, решения, ретроспективи и още.

  • Добавете видео обиколки: Вградете видео уроци директно в страниците на Confluence.

  • Достигнете до глобални екипи: Превеждайте съдържанието на Confluence на 65+ езика с един клик.

Кога да създадете свой собствен

Не толкова често, колкото хората си мислят. Atlassian предоставя голям брой шаблони и има още в Marketplace.

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

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

Как да създадете шаблон за Confluence

Механиката се различава леко между Confluence Cloud и Data Center и Atlassian периодично променя нещата, така че проверете тяхната актуална документация за точните пътища на кликовете. Формата на процеса е стабилна.

  1. Отидете в space settings за шаблон за пространство или в зоната за глобална администрация за глобален. Шаблоните се намират в зона за администриране, а не се създават от страница.

  2. Създайте нов шаблон и му дайте ясно име.

  3. Изградете структурата в редактора на шаблона: заглавия, оформления, таблици, макроси.

  4. Добавете променливи за всичко, което потребителят трябва да бъде подканен да попълни.

  5. Добавете placeholder текст, за да обясните какво принадлежи във всяка секция.

  6. Добавете етикети, за да се категоризират автоматично страниците, създадени от него.

  7. Напишете описание. Това е, което хората виждат, когато избират шаблон, и почти винаги остава празно.

  8. Запазете и създайте тестова страница от него, за да видите какво реално преживява потребителят.

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

Създаване на шаблон от съществуваща страница

В Confluence няма конверсия с един клик „превърнете тази страница в шаблон“, което изненадва хората. Това, което работи на практика:

Отворете съществуващата страница, копирайте съдържанието ѝ, създайте нов шаблон в пространството или в зоната за глобални шаблони и поставете съдържанието. След това премахнете всичко, специфично за конкретния екземпляр: имена, дати, реални данни, завършено съдържание. Заменете премахнатото съдържание с placeholder текст, който обяснява какво принадлежи там, и добавете променливи за полетата, които трябва да бъдат подканени да попълнят.

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

Някои приложения от Marketplace добавят директна конверсия страница-към-шаблон, което си струва да обмислите, ако го правите често.

Променливи

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

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

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

Три до пет променливи е разумен максимум.

Placeholder текст

Инструктивен текст, който се показва в сиво в шаблона и изчезва веднага щом потребителят започне да пише върху него. Най-недооценената функция в шаблоните за Confluence и тази, която най-много подобрява приемането.

Добър placeholder текст казва на човека какво принадлежи в секцията и, идеално, как изглежда „добре“. „Опишете решението, опциите, които са били разгледани, и защо е избрано точно това. Два или три изречения.“ Това е много по-полезно от празно заглавие.

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

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

Етикети

Шаблоните могат да прилагат етикети автоматично към всяка страница, създадена от тях.

Това има по-голямо значение, отколкото изглежда, защото етикетите правят съдържанието в Confluence намираемо и отчитаемо. Шаблон за бележки от среща, който прилага meeting-notes етикет, означава, че можете да изградите индекс на всяка бележка от среща в пространство, да филтрирате по етикет в търсенето и да използвате отчети за page properties.

Задайте етикетите в шаблона и потребителите никога няма да трябва да ги помнят. Разчитайте на потребителите да добавят етикети ръчно и почти никой няма да го направи.

Макросът Create from Template

Най-близкото до blueprint поведение без разработка на приложение и функцията, която повечето хора не знаят, че съществува.

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

Това решава проблема с намираемостта, който е основната причина шаблоните да не се използват. Вместо да очаквате хората да навигират до избора на шаблони и да търсят в списък, поставяте бутона там, където се върши работата: бутон на началната страница на екипа, който казва „New meeting note“, и бутон в проектното пространство, който казва „Raise a decision record“.

Комбинирайте го с отчет за page properties на същата страница и получавате нещо близко до blueprint поведение: бутон за създаване и автоматично поддържан индекс на всичко, което е създадено.

Ако изградите едно нещо от това ръководство, изградете това.

Дизайн на шаблон, който хората наистина ще използват

  • По-малко секции. Шаблон с дванадесет секции се попълва наполовина и се изоставя. Шест обикновено са напълно достатъчни.

  • Подредете според това кога хората знаят нещата. Поставете това, което могат да попълнят веднага, най-отгоре, а това, което изисква проучване, по-надолу.

  • Placeholder текст навсякъде, обясняващ какво принадлежи във всяка секция.

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

  • Не назовавайте конкретни хора. Те сменят ролите си и шаблонът не се променя.

  • Следете ширината на страницата. Шаблони, проектирани за голям монитор, могат да изглеждат „смачкани“ другаде, а оформленията на цялата ширина не подхождат на всеки тип съдържание.

  • Бъдете консервативни с макросите. Не всеки макрос се държи идентично в шаблон и сложното „вложено“ е мястото, където шаблоните се чупят по начини, които трудно се диагностицират.

  • Напишете описанието. Това е, което хората четат при избора, и почти винаги е празно.

Как да направите шаблоните намираеми

Истинската причина шаблоните да се провалят и почти нищо в документацията на Atlassian не го адресира.

По подразбиране пътят изисква някой да помни, че шаблоните съществуват, да отвори избора на шаблони и да идентифицира правилния от списък с имена. На всяка от тези стъпки копирането на страницата от миналото тримесечие е по-лесно.

Какво работи:

  • Бутоните от макроса Create from Template на страниците, където хората започват работа.

  • Индексна страница с шаблони във всяко пространство, която изброява какво съществува и кога да се използва всеки.

  • Описателни имена. „Бележки от седмична среща на екипа“, а не „Template 3“ или „TMPL_MTG“.

  • Попълнени описания, тъй като picker-ът ги показва.

  • По-малко шаблони. Шест намираеми и поддържани шаблона са по-добри от четиридесет, които никой не намира.

  • Шаблони, споменати в процеса, а не само налични. Ако чеклистът за onboarding казва „create a project brief“, свържете бутона.

Насърчаване на приемането

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

  • Пилотирайте с един екип, преди да го пуснете глобално.

  • Покажете го веднъж, на живо. Тридесет секунди в среща на екипа са по-добре от анонс, който никой не чете.

  • Заменете алтернативата. Ако хората копират стара страница, архивирайте старата страница или направете бутона по-удобен от намирането ѝ.

  • Следете какво се изтрива. Ако всеки потребител изтрива една и съща секция, премахнете я.

  • Следете какво се добавя. Ако хората последователно добавят секция, добавете я към шаблона.

Последните две са най-полезните сигнали и почти никой не ги гледа.

Поддържане на библиотеката

  • Назначете собственик за всеки шаблон, конкретна роля с име, а не администраторът на пространството по подразбиране.

  • Преглеждайте тримесечно, премахвайки всичко, което не се използва. Confluence не отчита директно използването на шаблони, така че индиректният показател е броенето на страници, които носят етикета на шаблона.

  • Версионирайте промените в описанието на шаблона, за да знаят хората, че е преместен.

  • Окастряйте агресивно. Библиотека, в която една трета от шаблоните са остарели, учи хората, че никой от тях не е надежден.

  • Проверявайте след обновления на Confluence, тъй като промените в редактора понякога влияят върху това как се визуализират шаблоните.

Известни ограничения

Струва си да ги знаете, преди да проектирате около нещо, което не работи.

Не всеки макрос се държи по един и същи начин в шаблон, както на страница, и някои не се пренасят чисто. Като цяло прикачени файлове не могат да се включват в шаблон. Променливите са само за създаване, не са „живи“ полета. Няма вградена конверсия страница-към-шаблон. Шаблоните не могат да налагат завършване, така че нищо не спира потребител да публикува страница с всички секции празни. И не можете да изградите истинско blueprint поведение, включително създаване на множество страници и автоматично поддържане на индекс, без разработка на приложение.

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

Най-добри практики

  • Шаблони за пространство по подразбиране, глобални само когато всичко се нуждае от тях.

  • Шест секции или по-малко.

  • Placeholder текст във всяка секция.

  • Максимум три до пет променливи.

  • Етикети, прилагани от шаблона, а не от потребителя.

  • Написани описания.

  • Бутоните от макроса Create from Template там, където започва работата.

  • Пилотиране с един екип преди пускане.

  • Собственик и тримесечен преглед за всеки шаблон.

  • Премахвайте всичко неизползвано.

Чести грешки

  • Изграждане на шаблона без да питате хората, които ще го използват.

  • Дванадесет секции, така че страниците да се попълват наполовина.

  • Без placeholder текст, така че никой да не знае какво къде принадлежи.

  • Инструктивен текст, въведен като обикновен текст, който след това се появява във всяка публикувана страница.

  • Реални данни, оставени в шаблон, направен от съществуваща страница.

  • Имена на конкретни хора, вградени вътре.

  • Празни описания, така че picker-ът е безполезен.

  • Всичко създадено като глобален шаблон.

  • Шаблони, които съществуват, но не са свързани от никъде, където хората работят.

  • Четиридесет шаблона, три в употреба.

  • Няма собственик, така че нищо не се актуализира.

  • Очакване шаблонът да реши проблем, който всъщност е свързан с това, че хората не знаят какво да напишат.

Шаблонът дава структура, не съдържание

Шаблоните за Confluence решават добре проблем със структурата. Те не могат да решат по-често срещания проблем, че хората знаят от какви секции се нуждае документът, но пак не могат да ги попълнят, защото процесът, който се документира, живее в нечия глава.

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

Запишете процеса веднъж и Trupeer AI ще генерира написаната документация и разказана video walkthrough от същото преминаване, която можете да вградите в страницата на Confluence, вместо да описвате система с проза. Приложете вашия brand kit, за да съвпадне всичко, преведете я на 65+ езика за разпределени екипи и поддържайте набора в knowledge base заедно с всичко, което живее в Confluence.

Запишете го. Брандирайте го. Преведете го. Trupeer-нете го.

Често задавани въпроси

Как създавате шаблон в Confluence?

Шаблоните се създават от space settings за шаблон за пространство или от глобална администрация за глобален, а не от страница. Изградете структурата в редактора на шаблона, добавете променливи за подканените полета, добавете placeholder текст, който обяснява всяка секция, приложете етикети и напишете описание. Документацията на Atlassian има текущите стъпки клик-по-клик, които се променят периодично.

Как създавате шаблон за Confluence от съществуваща страница?

Няма вградена конверсия с един клик. Копирайте съдържанието на страницата, създайте нов шаблон, поставете го и след това премахнете всичко, специфично за този екземпляр: имена, дати, реални данни и завършено съдържание. Заменете това, което сте премахнали, с placeholder текст. Стъпката с премахването обикновено е мястото, където се обърква, и останалите реални данни се копират напред безкрайно.

Безплатни ли са шаблоните за Confluence?

Confluence включва голям набор от вградени шаблони и blueprints във всички планове и можете да създадете свои без допълнителни разходи. Някои приложения от Marketplace, които добавят функционалност за шаблони, като конверсия страница-към-шаблон или групово управление, са платени.

Каква е разликата между Confluence blueprint и template?

Template е структура на страница, от която създавате страница. Blueprint е template плюс поведение: може да подканва с диалог, да създава множество страници и да поддържа индексна страница, която изброява всичко, създадено от него. Можете да изграждате templates сами, но blueprints изискват разработка на приложение. Ако някой поиска blueprint, обикновено иска индексната страница, която можете да приближите с макроса Create from Template и отчет за page properties.

Как използвате шаблони в Confluence?

Когато създавате страница, изберете шаблон вместо да започвате от празно. Ако шаблонът има променливи, ще бъдете подканени да ги попълните, преди страницата да се отвори. Като алтернатива кликнете върху бутон от макроса Create from Template, поставен върху страница — това е по-надеждният път, защото поставя шаблона там, където хората вече работят.

Какво е макросът Create from Template?

Макрос, който поставяте върху страница и който визуализира бутон. Кликването върху него създава нова страница от посочен шаблон, по избор под посочен родител. Това е най-ефективната корекция за ниско приемане на шаблони, защото премахва нуждата на някого да намира picker-а на шаблони. Сдвоете го с отчет за page properties на същата страница и получавате нещо близко до blueprint поведение.

Какво е placeholder текст за шаблони в Confluence?

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

Как да направите красиви шаблони за страници в Confluence?

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

Колко шаблона за Confluence трябва да има един екип?

По-малко от това, с което повечето екипи свършват. Шест намираеми, поддържани шаблона струват повече от четиридесет в picker, който никой не скролва. Ако една трета от библиотеката ви е неизползвана след тримесечие, я почистете, защото остаряла библиотека учи хората да не се доверяват на нищо от нея.

Защо никой не използва нашите шаблони за Confluence?

Обикновено заради намираемостта, а не заради качеството. По подразбиране пътят изисква да помните, че шаблоните съществуват, да отворите picker-а и да идентифицирате правилния, а на всяка стъпка копирането на стара страница е по-лесно. Поставете бутоните Create from Template там, където започва работата, напишете описанията и се уверете, че шаблонът е споменат в процеса, а не просто е наличен.

Можете ли да редактирате шаблон за Confluence, след като са създадени страници от него?

Да, и редакцията му не променя страниците, които вече са създадени. Шаблоните са отправна точка, а не „жив“ линк, така че съществуващите страници запазват структурата, с която са създадени. Това означава, че корекцията на шаблона подобрява само бъдещите страници, а всичко, което вече е грешно, остава грешно.

Какви са променливите в шаблоните за Confluence?

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

Свързани шаблони

Нуждаете се от видео редактор, преводач и сценарист?

Пробвайте Trupeer безплатно

Запазете демонстрация

Нуждаете се от видео редактор, преводач и сценарист?

Пробвайте Trupeer безплатно

Запазете демонстрация

Нуждаете се от видео редактор, преводач и сценарист?

Пробвайте Trupeer безплатно

Запазете демонстрация