Confluence에서 디자인

안녕하십니까!

제 이름은 Masha이고 Tinkoff 그룹 회사에서 품질 보증 엔지니어로 일하고 있습니다. QA 업무는 서로 다른 팀, 서로 다른 사람들과 많은 커뮤니케이션을 해야 하고, 저도 교육 프로그램의 매니저이자 강사였기 때문에 커뮤니케이션 맵이 최대한 넓었습니다. 그리고 어느 시점에서 저는 폭발했습니다. 저는 더 이상 읽을 수 없는 수많은 표와 문서를 채울 수 없다는 것을 깨달았습니다.

분명히 여러분 각자는 내가 말하는 것을 상상하고 식은 땀을 흘 렸습니다. 알파벳 순서가없는 성 목록, 조잡한 레이아웃의 수백 열이있는 테이블, 손가락을 지워야하는 수천 줄이있는 테이블 마우스 휠에서 머리글, 번호가 지정되지 않은 수많은 지침 페이지, 분석 및 체계화해야 하는 데이터와 함께 서로에게 보낸 수백 개의 편지를 읽을 수 없는 동일한 테이블에 채워넣습니다.

그래서 마음이 조금 진정되었을 때 이 글을 쓰기로 결심했습니다. 제품이 아닌 다양한 문서를 정상적으로(때때로 편리하게) 유지 관리할 수 있는 방법에 대해 이야기하겠습니다. 기사가 네트워크에 흩어지고 개발에 인접한 부서의 지옥 수준이 조금이라도 떨어지고 사람들 (나 포함)이 조금 더 행복해지기를 바랍니다.

도구

제품 문서는 종종 코드와 함께 보관되는데 이는 좋은 일입니다. 그리고 비 제품 문서는 일반적으로 어디에나 저장됩니다. 종종 사람들은 서로 다른 위치의 정보를 Confluence로 가져오려고 시도하며 우리도 예외는 아닙니다. 나머지 이야기는 그에 관한 것입니다.

일반적으로 Confluence는 고급 위키 엔진입니다. 서식이 있는 텍스트, 표, 다양한 차트 등 다양한 유형의 데이터로 작업할 수 있습니다. 이것은 매우 흥미롭고 강력한 도구이지만 요리 방법을 모른다면 읽을 수 없는 문서 더미를 또 얻게 될 것입니다. 내가 요리하는 법을 가르쳐 줄게!

매크로

Confluence의 거의 모든 마법은 매크로를 중심으로 구축됩니다. 많은 매크로가 있으며 서로 결합할 수 있습니다. 그들은 유료이고 무료이며, 문서에 대한 링크가 있는 매크로의 다양한 예가 있을 것입니다.

매크로 작업을 위한 인터페이스는 가능한 한 간단합니다. 매크로를 추가하려면 플러스를 클릭하고 목록에서 원하는 요소를 선택해야 합니다.

매크로가 자급자족하는 경우, 즉 자체 내부에 다른 항목을 삽입할 필요가 없으면 블록처럼 보입니다.

매크로가 작동하기 위해 내부에 무언가가 필요한 경우 상자처럼 보입니다.

동시에 피라미드에 논리가 있는 한 한 프레임 안에 원하는 만큼 다른 것을 넣을 수 있습니다.

각 매크로에는 미리보기가 있습니다. 매크로를 올바르게 채우고 구성했는지 여부를 즉시 보여줍니다.

템플릿

매크로 외에도 콘텐츠를 미리 채울 수 있는 편리한 도구가 있습니다. 바로 템플릿입니다.
페이지를 만들 때 템플릿을 사용할 수 있습니다. "만들기" 버튼 옆에 있는 세 개의 점을 클릭하고 원하는 템플릿을 선택하기만 하면 됩니다.

그러면 템플릿에 있는 모든 콘텐츠가 생성된 페이지에 추가됩니다.

누구나 템플릿에서 페이지를 만들 수 있지만 템플릿을 직접 만들거나 편집할 수 있는 권한이 있는 사람만 페이지를 만들 수 있습니다. 페이지 유지 관리 방법에 대한 추가 지침을 템플릿에 추가할 수 있습니다.

테이블 매직

사실 저는 기술자로서 테이블을 매우 좋아하고 테이블에 거의 모든 정보를 포함할 수 있습니다(항상 효과적인 것은 아니지만). 테이블 자체는 명확하고 구조적이며 확장 가능하고 마술적입니다!

그러나 테이블과 같은 멋진 개체도 손상될 수 있습니다. 그리고 성공적으로 사용하고 개선할 수도 있습니다. 아래에서 자세히 알아보세요.

필터링(유료 플러그인)

읽을 수 없는 거대한 테이블은 필터링을 사용하여 조금 덜 거대하고 더 읽기 쉽게 만들 수 있습니다. 이를 위해 유료 매크로를 사용할 수 있습니다. 테이블 필터.

이 매크로 내에서 테이블을 밀어야 합니다(가장 못생긴 테이블도 가능하며 가장 중요한 것은 테이블을 완전히 밀어내는 것입니다). 매크로에서 드롭다운 필터, 텍스트 필터, 숫자 및 날짜 필터에 대한 열을 선택할 수 있습니다.

모든 공석에 대한 후보자에 대한 모든 정보가 표 목록에 기록된다고 상상해보십시오. 당연히 정렬되지 않음 - 사람들은 알파벳 순서로 인터뷰에 오지 않습니다. 그리고 이전에 특정 지원자를 인터뷰한 적이 있는지 이해해야 합니다. 이 지옥을 필터 매크로에 넣고 성으로 텍스트 필터를 추가하기만 하면 됩니다. 그러면 정보가 화면에 표시됩니다.

거대한 테이블을 필터링하면 시스템 성능과 페이지 로드 시간에 영향을 미칠 수 있으므로 거대한 테이블을 필터에 넣는 것은 임시 방편이므로 사람들이 읽을 수 없는 거대한 테이블을 만들지 않아도 되는 프로세스를 구축하는 것이 좋습니다( 프로세스의 예는 기사 끝에 있습니다).

정렬(유료 플러그인)

매직 매크로 사용 테이블 필터 열에 대한 기본 정렬을 설정하고 행에 번호를 매길 수도 있습니다. 또는 필터 매크로에 넣은 테이블의 열을 클릭하면 이 열을 기준으로 정렬이 수행됩니다.

예를 들어 지원자와 같은 테이블이 있고 특정 달에 몇 번의 인터뷰가 있었는지 파악해야 합니다. 날짜별로 정렬하고 기뻐하세요.

피벗 테이블(유료 플러그인)

이제 더 흥미로운 사례로 넘어 갑시다. 테이블이 거대하고 테이블에서 무언가를 계산해야 한다고 상상해 보십시오. 물론 Excel로 복사하여 필요한 것을 계산하고 데이터를 다시 Confluence에 업로드할 수 있습니다. 매크로를 한 번 적용할 수 있습니까? "피벗 테이블" 동일한 결과를 얻고 업데이트만 합니다.

예를 들어, 모든 직원의 데이터가 포함된 테이블이 있습니다. 즉 직원의 지리적 위치와 직위가 있습니다. 각 도시에 얼마나 많은 사람이 있는지 계산하려면 "피벗 테이블" 매크로에서 데이터가 집계되는 행(위치)과 작업 유형(추가)을 선택해야 합니다.

당연히 한 번에 여러 기준에 따라 그룹화할 수 있으며 모든 가능성을 볼 수 있습니다. 문서에서.

차트(유료 플러그인)

내가 말했듯이 모든 사람이 나만큼 테이블을 좋아하는 것은 아닙니다. 불행히도 대부분의 관리자는 그들을 전혀 좋아하지 않습니다. 그러나 모두가 밝은 색상 차트를 좋아합니다.
Confluence의 제작자는 확실히 이것에 대해 알고 있었습니다. 따라서 매직 매크로를 사용할 수 있습니다. "테이블에서 차트". 이 매크로에서는 이전 단락의 피벗 테이블을 넣어야 합니다. 지루한 회색 데이터가 아름답게 시각화됩니다.

당연히 이 매크로에도 설정이 있습니다. 모든 매크로에 대한 문서 링크는 해당 매크로의 편집 모드에서 찾을 수 있습니다.

집계 용이성

이전 단락의 정보는 아마도 귀하에게 계시가 아니었을 것입니다. 그러나 이제 매크로 사용 방법을 확실히 알게 되었으며 기사의 더 흥미로운 부분으로 넘어갈 수 있습니다.

태그

사람들이 구조화되지 않은 하나의 기사나 거대한 테이블에 정보를 저장하는 것은 좋지 않습니다. 더 나쁜 것은 이 정보의 일부를 읽을 수 없을 뿐만 아니라 Confluence 전체에 흩어져 있는 경우입니다. 다행스럽게도 흩어진 정보를 한곳에 모을 수 있다. 이를 위해 당신은 사용해야합니다 라벨 (소셜 네트워크의 모든 사람에게 친숙한 태그).

모든 페이지에 원하는 수의 태그를 추가할 수 있습니다. 태그를 클릭하면 관련 태그 집합뿐만 아니라 해당 태그가 있는 모든 콘텐츠에 대한 링크가 있는 집계 페이지로 이동합니다. 관련 태그는 같은 페이지에 자주 나타나는 태그입니다.

페이지 속성

정보 구조화를 위해 다른 흥미로운 매크로를 페이지에 추가할 수 있습니다. "페이지 속성". 그 안에 두 개의 열로 구성된 테이블을 제출해야 합니다. 첫 번째 열은 키이고 두 번째 열은 속성 값입니다. 또한 콘텐츠 읽기를 방해하지 않도록 매크로를 페이지에서 숨길 수 있지만 페이지에는 여전히 필요한 키가 표시됩니다.

ID에 주의하십시오. 서로 다른 페이지에 서로 다른 속성 그룹(또는 한 페이지에 서로 다른 속성 그룹)을 걸도록 설정하는 것이 편리합니다.

보고서

태그로 보고서를 수집할 수 있습니다. 예를 들어, 매크로 콘텐츠 보고서 특정 태그 집합이 있는 모든 페이지를 수집합니다.

그러나 더 흥미로운 보고서는 매크로입니다. 페이지 속성 보고서. 또한 특정 태그 세트가 있는 모든 페이지를 수집하지만 단순히 나열하는 것이 아니라 열이 페이지 속성의 키인 테이블을 컴파일합니다(기사 시작 부분과 연결되어 있습니까?).

다양한 출처의 정보 요약표가 나옵니다. 편리한 기능이 있다는 것이 좋습니다: 적응형 레이아웃, 임의의 열로 정렬. 또한 이러한 보고 테이블은 매크로 내에서 구성할 수 있습니다.

구성할 때 보고서에서 일부 열을 제거하고 기본 상태 또는 표시된 레코드 수를 설정할 수 있습니다. 필요한 정보만 볼 수 있도록 페이지 속성 ID를 설정할 수도 있습니다.

예를 들어 직원 페이지가 많고 이러한 페이지에는 사람에 대한 속성 집합이 있습니다. 즉, 레벨, 위치, 팀에 합류한 시기 등이 있습니다. 이러한 속성은 id = 직원_inf. 그리고 같은 페이지에 두 번째 속성 세트가 있는데, 여기에는 팀의 일부인 사람에 대한 정보(그 사람이 수행하는 역할, 속해 있는 팀 등)가 포함되어 있습니다. 이러한 속성은 아이디 = team_inf. 그런 다음 보고서를 컴파일할 때 하나 또는 두 개의 ID에 대한 정보만 한 번에 표시할 수 있습니다.

이 접근 방식의 장점은 모든 사람이 필요한 정보 테이블을 수집할 수 있다는 것입니다. 이 테이블은 아무 것도 복제하지 않고 기본 페이지가 업데이트될 때 업데이트됩니다. 예를 들어, 팀 리더는 개발자가 언제 일자리를 얻었는지 신경 쓰지 않지만 각자가 팀에서 어떤 역할을 하는지는 중요합니다. 팀장은 팀에 대한 보고서를 수집합니다. 그리고 회계사는 누가 어떤 역할을 수행하는지 상관하지 않지만 직책은 중요합니다. 직책에 대한 보고서를 수집합니다. 이 경우 정보의 출처를 복제하거나 양도하지 않습니다.

최종 공정

교수

따라서 매크로를 예로 사용하여 Confluence에서 정보를 아름답게 구조화하고 효과적으로 집계할 수 있습니다. 그러나 이상적으로는 새 정보가 즉시 구조화되고 이미 사용 중인 모든 집계 메커니즘에 포함되는지 확인해야 합니다.

여기에서 많은 매크로와 템플릿이 구조에 올 것입니다. 사람들이 올바른 형식으로 새 페이지를 만들도록 하려면 템플릿에서 만들기 매크로를 사용할 수 있습니다. 필요한 템플릿에서 새 페이지가 생성되는 버튼을 클릭하여 페이지에 버튼을 추가합니다. 이렇게 하면 사람들이 필요한 형식으로 즉시 작업하도록 할 수 있습니다.

페이지를 만들 수 있는 템플릿에서 레이블, "페이지 속성" 매크로 및 필요한 속성 테이블을 미리 추가해야 합니다. 또한 페이지를 채울 값과 속성 값에 대한 지침을 추가하는 것이 좋습니다.

그러면 최종 프로세스는 다음과 같습니다.

1. 특정 유형의 정보에 대한 템플릿을 만들고 있습니다.
2. 이 템플릿에서 매크로에 레이블 및 페이지 속성을 추가합니다.
3. 편리한 장소에서 템플릿에서 하위 페이지가 생성되는 버튼을 클릭하여 버튼이 있는 루트 페이지를 생성합니다.
4. 잠재적으로 필요한 정보를 생성할 사용자의 루트 페이지에서 시작합니다(원하는 템플릿에 따라 버튼을 클릭하여).
5. 템플릿에 지정한 태그를 통해 페이지 속성에 대한 보고서를 수집합니다.
6. 기뻐하십시오: 편리한 형식으로 필요한 모든 정보가 있습니다.

주의

품질 엔지니어로서 세상에 완벽한 것은 없다고 감히 말할 수 있습니다. 신성한 테이블조차도 불완전합니다. 그리고 위의 과정에는 함정이 있습니다.

• 페이지 속성의 이름이나 구성을 변경하기로 결정한 경우 해당 데이터가 요약 보고서로 올바르게 가져오도록 이미 생성된 모든 개체를 업데이트해야 합니다. 이것은 슬프지만 다른 한편으로는 정보 세트의 "아키텍처"에 대해 자세히 생각하도록 강요하며 이는 매우 흥미로운 작업입니다.
• 정보 테이블을 채우고 태그를 사용하는 방법에 대한 상당한 양의 지침을 작성해야 합니다. 그러나 다른 한편으로 이 기사를 적절한 사람들에게 던질 수 있습니다.

비제품 문서 저장의 예

위에서 설명한 프로세스를 통해 거의 모든 정보의 저장을 구성할 수 있습니다. 접근 방식의 장점은 보편적이라는 것입니다. 사용자가 일단 익숙해지면 더 이상 엉망진창이 되지 않습니다. 또한 큰 (그러나 무료는 아님) 플러스는 다양한 통계를 즉석에서 수집하고 아름다운 다이어그램을 그리는 기능입니다.

팀에 대한 정보를 유지 관리하는 프로세스의 예를 들어 보겠습니다.

팀의 각 개인에 대해 직원 카드를 만들기로 결정했습니다. 따라서 우리는 각각의 새로운 사람이 자신을 위해 이 카드를 만들고 그의 모든 개인 정보를 보관하는 템플릿을 가지고 있습니다.

보시다시피 속성에 대한 자세한 표가 있으며 이 페이지를 유지 관리하는 방법에 대한 지침이 즉시 제공됩니다. 일부 태그는 지침에 따라 직원이 직접 내려 놓았습니다. 템플릿에는 주요 태그인 카드 태그만 있습니다. 직원 카드, 방향 태그 방향 관련 및 명령 태그 팀 qa.

결과적으로 모든 사람이 카드를 만든 후 직원 정보가 포함된 완전한 테이블을 얻습니다. 이 정보는 다른 지점에서 사용할 수 있습니다. 리소스 관리자는 일반 테이블을 직접 수집할 수 있으며 팀 리더는 선택 항목에 팀 태그를 추가하여 명령 테이블을 수집할 수 있습니다.

예를 들어 태그별로 다른 요약을 볼 수 있습니다. qa 업그레이드 계획 QA 개발을 위한 모든 작업이 표시됩니다. 동시에 직원 카드의 각 사람은 중요한 이야기와 자신의 개발 계획을 유지합니다. 그는 개발 계획 템플릿에서 중첩된 페이지를 만듭니다.

결론

부끄러워하지 않고 사용자가 극도로 상처받지 않는 방식으로 문서를 보관하십시오!

이 기사가 유용하고 세계의 모든 문서에 질서가 있기를 진심으로 바랍니다.

출처 : habr.com