Xin chào tất cả mọi người!
Tên tôi là Masha, tôi làm kỹ sư đảm bảo chất lượng trong nhóm các công ty Tinkoff. Công việc QA liên quan đến giao tiếp nhiều với nhiều người từ các nhóm khác nhau, đồng thời tôi cũng là quản lý và giảng viên các chương trình giáo dục nên bản đồ giao tiếp của tôi càng rộng càng tốt. Và đến một lúc nào đó tôi phát nổ: Tôi nhận ra rằng tôi không thể nữa, tôi không thể, tôi không thể điền vào hàng tấn bảng và tài liệu không thể đọc được nữa.
Chắc chắn bây giờ mỗi bạn đều tưởng tượng những gì tôi đang nói và toát mồ hôi lạnh: danh sách họ không theo thứ tự bảng chữ cái, bảng có hàng trăm cột với bố cục cẩu thả, bảng có hàng nghìn dòng mà bạn cần xóa ngón tay trên con lăn chuột để tìm tiêu đề, hàng tấn trang hướng dẫn không đánh số, hàng trăm lá thư gửi cho nhau với dữ liệu cần được phân tích và hệ thống hóa và nhét vào cùng một bảng không thể đọc được.
Và vì vậy, khi tôi đã bình tĩnh lại một chút, tôi quyết định viết bài này. Tôi sẽ nói về cách thông thường (thậm chí đôi khi thuận tiện) bạn có thể duy trì nhiều loại tài liệu phi sản phẩm. Tôi hy vọng rằng bài báo sẽ lan truyền trên mạng và mức độ tồi tệ trong các bộ phận liền kề với sự phát triển sẽ giảm xuống ít nhất một chút, và mọi người (bao gồm cả tôi) sẽ trở nên hạnh phúc hơn một chút.
Dụng cụ
Tài liệu sản phẩm thường được giữ bên cạnh mã, đây là một điều tốt. Và tài liệu phi sản phẩm thường được lưu trữ ở bất cứ đâu. Mọi người thường cố gắng đưa thông tin từ những nơi khác nhau vào Confluence và chúng tôi cũng không ngoại lệ. Vì vậy, phần còn lại của câu chuyện là về anh ta.
Nói chung, Confluence là một công cụ wiki nâng cao. Nó cho phép bạn làm việc với dữ liệu ở các kiểu hiển thị khác nhau: văn bản có định dạng, bảng, biểu đồ khác nhau. Đây là một công cụ rất thú vị và mạnh mẽ, nhưng nếu bạn không biết cách sử dụng nó, thì bạn sẽ nhận được một đống tài liệu không thể đọc được khác. Tôi sẽ dạy bạn cách nấu ăn!
Macro
Hầu như tất cả sự kỳ diệu của Confluence được xây dựng xung quanh các macro. Có rất nhiều macro và chúng có thể được kết hợp với nhau. Chúng được trả tiền và miễn phí, hơn nữa sẽ có nhiều ví dụ khác nhau về macro có liên kết đến tài liệu dành cho chúng.
Giao diện làm việc với macro càng đơn giản càng tốt. Để thêm macro, bạn cần nhấp vào dấu cộng và chọn phần tử mong muốn từ danh sách.
Nếu macro là tự túc, nghĩa là nó không yêu cầu chèn thứ gì khác vào bên trong chính nó, thì nó trông giống như một khối.
Nếu một macro cần thứ gì đó bên trong nó để hoạt động, nó sẽ giống như một cái hộp.
Đồng thời, bạn có thể đặt bao nhiêu người khác tùy thích vào trong một khung, miễn là có logic trong kim tự tháp của bạn.
Mỗi macro có một bản xem trước: nó ngay lập tức hiển thị xem bạn đã điền và định cấu hình macro chính xác hay chưa.
Templates
Ngoài các macro, còn có một công cụ thuận tiện để điền trước nội dung - đây là một mẫu.
Các mẫu có thể được sử dụng khi tạo bất kỳ trang nào: chỉ cần nhấp vào ba dấu chấm bên cạnh nút "Tạo" và chọn mẫu mong muốn.
Sau đó, tất cả nội dung trong mẫu sẽ được thêm vào trang đã tạo.
Bất kỳ ai cũng có thể tạo trang từ các mẫu nhưng chỉ những người có quyền tự tạo hoặc chỉnh sửa mẫu mới có thể tạo trang. Bạn có thể thêm hướng dẫn bổ sung vào mẫu về cách duy trì trang.
Bảng ma thuật
Trên thực tế, là một tín đồ công nghệ, tôi vô cùng yêu thích các bảng và có thể gói gọn hầu hết mọi thông tin trong đó (mặc dù điều này không phải lúc nào cũng hiệu quả). Bản thân các bảng rõ ràng, có cấu trúc, có thể mở rộng, kỳ diệu!
Nhưng ngay cả một thực thể tuyệt vời như cái bàn cũng có thể bị hư hỏng. Và nó có thể được sử dụng thành công và thậm chí được cải thiện. Thêm về điều đó dưới đây.
Lọc (plugin trả phí)
Bất kỳ bảng khổng lồ nào không thể đọc được đều có thể được làm nhỏ hơn một chút và dễ đọc hơn một chút bằng cách sử dụng bộ lọc. Để làm điều này, bạn có thể sử dụng macro trả phí .
Bên trong macro này, bạn cần phải chuyển một bảng (ngay cả bảng xấu nhất cũng có thể, điều chính là chuyển nó hoàn toàn). Trong macro, bạn có thể chọn các cột cho bộ lọc thả xuống, bộ lọc văn bản, số và bộ lọc ngày.
Chỉ cần tưởng tượng rằng tất cả thông tin về các ứng cử viên cho tất cả các vị trí tuyển dụng được ghi lại trong một danh sách dạng bảng. Đương nhiên, không được sắp xếp - mọi người không đến phỏng vấn theo thứ tự bảng chữ cái. Và bạn cần hiểu nếu bạn đã phỏng vấn một ứng viên cụ thể trước đó. Bạn chỉ cần đặt địa ngục này vào macro bộ lọc, thêm bộ lọc văn bản theo họ - và thì đấy, thông tin sẽ có trên màn hình của bạn.
Cần lưu ý rằng việc lọc các bảng lớn có thể ảnh hưởng đến hiệu suất hệ thống và thời gian tải trang, do đó, việc đưa một bảng lớn vào bộ lọc chỉ là một biện pháp tạm thời, tốt hơn là xây dựng một quy trình trong đó mọi người không phải tạo các bảng lớn không thể đọc được (an ví dụ về quy trình sẽ ở cuối bài viết).
Sắp xếp (plugin trả phí)
Với Macro ma thuật bạn cũng có thể đặt cách sắp xếp mặc định trên bất kỳ cột nào và đánh số các hàng. Hoặc nhấp vào bất kỳ cột nào của bảng được đưa vào macro bộ lọc và việc sắp xếp theo cột này sẽ diễn ra.
Ví dụ: bạn có cùng bàn với các ứng viên và bạn cần tính xem có bao nhiêu cuộc phỏng vấn đã được tổ chức trong một tháng nhất định - sắp xếp theo ngày và vui mừng.
Pivot Table (plugin trả phí)
Bây giờ hãy chuyển sang một trường hợp thú vị hơn. Hãy tưởng tượng rằng bảng của bạn rất lớn và bạn cần tính toán thứ gì đó trên đó. Tất nhiên, bạn có thể sao chép nó sang Excel, tính toán những gì bạn cần và tải dữ liệu trở lại Confluence. Bạn có thể áp dụng macro một lần không? và nhận được kết quả tương tự, chỉ được cập nhật.
Ví dụ: bạn có một bảng chứa dữ liệu của tất cả nhân viên - vị trí địa lý của họ và họ giữ chức vụ gì. Để tính toán có bao nhiêu người ở mỗi thành phố, bạn cần chọn trong macro "Bảng tổng hợp" hàng mà dữ liệu được tổng hợp (vị trí) và loại hoạt động (bổ sung).
Đương nhiên, bạn có thể nhóm theo một số tiêu chí cùng một lúc, bạn có thể thấy tất cả các khả năng .
Biểu đồ (plugin trả phí)
Như tôi đã nói, không phải ai cũng yêu thích những chiếc bàn nhiều như tôi. Thật không may, hầu hết các nhà quản lý không thích chúng chút nào. Nhưng mọi người đều thích những biểu đồ có màu sắc tươi sáng.
Những người tạo ra Confluence chắc chắn biết về điều này (chắc chắn họ cũng có những ông chủ yêu thích các báo cáo và biểu đồ, họ sẽ ra sao nếu không có nó). Do đó, bạn có thể sử dụng macro kỳ diệu . Trong macro này, bạn cần đặt bảng tổng hợp từ đoạn trước và voila - dữ liệu màu xám nhàm chán của bạn được hiển thị đẹp mắt.
Đương nhiên, macro này cũng có cài đặt. Liên kết đến tài liệu cho bất kỳ macro nào có thể được tìm thấy trong chế độ chỉnh sửa của macro đó.
Dễ tổng hợp
Thông tin từ các đoạn trước có lẽ không phải là một tiết lộ cho bạn. Nhưng bây giờ bạn chắc chắn đã biết cách sử dụng macro và tôi có thể chuyển sang phần thú vị hơn của bài viết.
Nhãn
Thật tệ khi mọi người lưu trữ thông tin trong một bài viết không có cấu trúc hoặc một bảng lớn. Tệ hơn nữa là khi các phần của thông tin này không chỉ không thể đọc được mà còn nằm rải rác trên các phần mở rộng của Confluence. May mắn thay, có thể thu thập thông tin rải rác ở một nơi. Đối với điều này, bạn cần phải sử dụng (thẻ quen thuộc với mọi người trên mạng xã hội).
Bất kỳ số lượng thẻ nào cũng có thể được thêm vào bất kỳ trang nào. Nhấp vào một thẻ sẽ đưa bạn đến một trang tổng hợp có liên kết đến tất cả nội dung có thẻ đó, cũng như tập hợp các thẻ có liên quan. Các thẻ liên quan là những thẻ xuất hiện thường xuyên trên cùng một trang.
Thuộc tính trang
Bạn có thể thêm một macro thú vị khác vào trang để biết cấu trúc thông tin - . Bên trong nó, bạn cần gửi một bảng gồm hai cột, cột đầu tiên sẽ là khóa và cột thứ hai sẽ là giá trị của thuộc tính. Hơn nữa, macro có thể được ẩn khỏi trang để nó không cản trở việc đọc nội dung, nhưng trang vẫn sẽ được đánh dấu bằng các phím cần thiết.
Hãy chú ý đến ID - thật thuận tiện khi đặt nó để treo các nhóm thuộc tính khác nhau trên các trang khác nhau (hoặc thậm chí các nhóm thuộc tính khác nhau trên một trang).
báo cáo
Theo thẻ, bạn có thể thu thập báo cáo. Ví dụ, vĩ mô thu thập tất cả các trang với một bộ thẻ nhất định.
Nhưng một báo cáo thú vị hơn là một macro . Nó cũng thu thập tất cả các trang với một bộ thẻ nhất định, nhưng không chỉ liệt kê chúng mà lập thành một bảng (bạn có bắt gặp mối liên hệ với phần đầu của bài viết không?), trong đó các cột là khóa của thuộc tính trang.
Hóa ra một bảng tóm tắt thông tin từ các nguồn khác nhau. Thật tuyệt khi nó có các tính năng tiện lợi: bố cục thích ứng, sắp xếp theo bất kỳ cột nào. Ngoài ra, một bảng báo cáo như vậy có thể được cấu hình bên trong macro.
Khi định cấu hình, bạn có thể xóa một số cột khỏi báo cáo, đặt trạng thái mặc định hoặc số lượng bản ghi được hiển thị. Bạn cũng có thể đặt ID thuộc tính trang để chỉ xem thông tin bạn cần.
Ví dụ: bạn có nhiều trang nhân viên, các trang này có một tập hợp các thuộc tính về một người: cấp độ của anh ta, anh ta ở đâu, anh ta tham gia nhóm khi nào, v.v. Các thuộc tính này được đánh dấu id = employee_inf. Và có một bộ thuộc tính thứ hai trên cùng một trang, chứa thông tin về một người trong nhóm: người đó thực hiện vai trò gì, anh ta thuộc nhóm nào, v.v. Các thuộc tính này được đánh dấu ID = team_inf. Sau đó, khi soạn báo cáo, bạn chỉ có thể hiển thị thông tin cho một hoặc hai ID cùng một lúc - tùy theo cách nào thuận tiện hơn.
Cái hay của phương pháp này là mọi người đều có thể thu thập bảng thông tin họ cần, bảng này sẽ không trùng lặp bất kỳ thứ gì và sẽ được cập nhật khi trang chính được cập nhật. Ví dụ: một trưởng nhóm không quan tâm đến việc các nhà phát triển của anh ta có việc làm khi nào mà điều quan trọng là mỗi người trong số họ đóng vai trò gì trong nhóm. Trưởng nhóm sẽ thu thập một báo cáo về đội. Và nhân viên kế toán không quan tâm ai thực hiện vai trò gì, nhưng các vị trí rất quan trọng - anh ta sẽ thu thập báo cáo về các vị trí. Trong trường hợp này, nguồn thông tin sẽ không được sao chép hoặc chuyển giao.
quá trình cuối cùng
Hướng dẫn
Vì vậy, chúng ta có thể cấu trúc đẹp mắt và tổng hợp thông tin hiệu quả trong Confluence bằng cách sử dụng macro làm ví dụ. Nhưng lý tưởng nhất là bạn cần đảm bảo rằng thông tin mới được cấu trúc ngay lập tức và được đưa vào tất cả các cơ chế tổng hợp đã được sử dụng.
Tại đây, một loạt các macro và mẫu sẽ đến để giải cứu. Để khiến mọi người tạo các trang mới ở định dạng phù hợp, bạn có thể sử dụng macro Tạo từ mẫu. Nó thêm một nút vào trang, bằng cách nhấp vào đó, một trang mới được tạo từ mẫu bạn cần. Bằng cách này, bạn buộc mọi người phải ngay lập tức làm việc theo định dạng mà bạn cần.
Trong mẫu mà bạn cho phép tạo trang, bạn cần thêm nhãn, macro "Thuộc tính trang" và bảng các thuộc tính bạn cần trước. Tôi cũng khuyên bạn nên thêm hướng dẫn về những giá trị cần điền vào trang và giá trị thuộc tính.
Sau đó, quá trình cuối cùng sẽ như thế này:
- Bạn đang tạo một mẫu cho một loại thông tin cụ thể.
- Trong mẫu này, hãy thêm nhãn và thuộc tính trang trong macro.
- Ở bất kỳ nơi thuận tiện nào, hãy tạo một trang gốc bằng một nút, bằng cách nhấp vào trang con được tạo từ mẫu.
- Bắt đầu trên trang gốc của những người dùng có khả năng tạo thông tin cần thiết (theo mẫu mong muốn, bằng cách nhấp vào nút).
- Thu thập cho mình một báo cáo về các thuộc tính của trang thông qua các thẻ mà bạn đã chỉ định trong mẫu.
- Hãy vui mừng: bạn có tất cả thông tin bạn cần ở một định dạng thuận tiện.
Cạm bẫy
Là một kỹ sư chất lượng, tôi có thể yên tâm nói rằng không có gì hoàn hảo trên thế giới. Ngay cả những bàn thần thánh cũng không hoàn hảo. Và có những cạm bẫy trong quá trình trên.
- Nếu bạn quyết định thay đổi tên hoặc thành phần của các thuộc tính trang, bạn sẽ phải cập nhật tất cả các đối tượng đã được tạo để dữ liệu của chúng được đưa vào báo cáo tóm tắt một cách chính xác. Điều này thật đáng buồn, nhưng mặt khác, nó buộc bạn phải suy nghĩ chi tiết về "kiến trúc" của tập hợp thông tin của bạn, đây là một nhiệm vụ rất thú vị.
- Bạn sẽ phải viết kha khá hướng dẫn cách điền các bảng thông tin và sử dụng các thẻ. Nhưng mặt khác, bạn chỉ có thể ném bài báo này vào tất cả những người phù hợp.
Một ví dụ về lưu trữ tài liệu phi sản phẩm
Thông qua quy trình được mô tả ở trên, bạn có thể tổ chức lưu trữ hầu hết mọi thông tin. Cái hay của phương pháp này là nó phổ biến: một khi người dùng đã quen với nó, họ sẽ ngừng làm lộn xộn. Ngoài ra, một điểm cộng lớn (nhưng không miễn phí) là khả năng thu thập các số liệu thống kê khác nhau một cách nhanh chóng và vẽ các sơ đồ đẹp mắt trên đó.
Tôi sẽ đưa ra một ví dụ về quy trình duy trì thông tin về nhóm của chúng tôi.
Đối với mỗi người trong nhóm, chúng tôi quyết định tạo một thẻ nhân viên. Theo đó, chúng tôi có một mẫu theo đó mỗi người mới tạo thẻ này cho chính mình và giữ tất cả thông tin cá nhân của mình trong đó.
Như bạn có thể thấy, chúng tôi có một bảng thuộc tính chi tiết và ngay lập tức có hướng dẫn về cách duy trì trang này. Một số tag do nhân viên tự dán xuống theo hướng dẫn, trong template chỉ có tag chính: tag thẻ thẻ nhân viên, nhãn hướng liên quan đến hướng và thẻ lệnh đội-qa.
Kết quả là sau khi mọi người đã tạo thẻ cho mình, sẽ thu được một bảng hoàn chỉnh với thông tin về nhân viên. Thông tin này có thể được sử dụng tại các điểm khác nhau. Người quản lý tài nguyên có thể thu thập các bảng chung cho chính họ và trưởng nhóm có thể thu thập các bảng lệnh bằng cách thêm thẻ nhóm vào lựa chọn.
Theo thẻ, bạn có thể xem các bản tóm tắt khác nhau, chẳng hạn như theo qa-nâng cấp-kế hoạch tất cả các nhiệm vụ để phát triển QA sẽ được hiển thị. Đồng thời, mỗi người trong thẻ nhân viên của mình giữ một câu chuyện quan trọng và kế hoạch phát triển của riêng mình - anh ta tạo một trang lồng nhau từ mẫu kế hoạch phát triển.
Kết luận
Giữ bất kỳ tài liệu nào theo cách mà bạn không xấu hổ về nó và người dùng không bị tổn thương nặng nề!
Tôi thực sự hy vọng rằng bài viết sẽ hữu ích và trật tự sẽ xuất hiện trong tất cả các tài liệu trên thế giới.
Nguồn: www.habr.com