Cách viết tài liệu người dùng cho hướng dẫn kiểu web

Hướng dẫn phong cách đưa ra các quy tắc sử dụng cho các yếu tố trực quan của một thương hiệu; chúng thường được sử dụng bởi các tổ chức muốn giữ một hình ảnh nhất quán trên toàn bộ nội dung được tạo bởi nhiều người. Hướng dẫn kiểu Web đặc biệt quan trọng nếu nội dung trực tuyến của bạn được tạo và chỉnh sửa bởi người dùng với các cấp độ kỹ năng khác nhau. Bằng cách đặt ra các quy tắc cụ thể cho các trang Web được liên kết với tổ chức của bạn, bạn có thể giúp đảm bảo mọi trang sẽ quảng bá một danh tính nhất quán, chuyên nghiệp. Khi bạn viết tài liệu người dùng cho hướng dẫn về phong cách, hãy sử dụng ngôn ngữ rõ ràng, súc tích và viết cho người dùng có trình độ kỹ năng thiết kế Web thấp nhất.

1.

Mở tài liệu với lời giải thích tổng thể về bố cục và kiểu dáng Web cho từng loại trang. Mặc dù các danh mục trang cụ thể sẽ thay đổi theo tổ chức, hãy xem xét trang đích, trang tiêu đề, trang chủ, trang danh mục phụ, trang chỉ có hình ảnh và trang chỉ có văn bản. Sử dụng sơ đồ cấu trúc để giải thích các phân cấp thông tin phức tạp và bao gồm đồ họa hiển thị các ví dụ về từng bố cục.

2.

Giải thích cách sử dụng logo trên các loại trang Web khác nhau. Cho người dùng biết nơi họ nên đặt logo và liệt kê các giới hạn trên và dưới cho kích thước. Nếu bạn có nhiều bố cục logo và biến thể màu sắc, hãy liệt kê những địa điểm chúng có thể được sử dụng; sử dụng dấu logo một mình có thể được cho phép trên một trang sử dụng tiêu đề đầy đủ của tổ chức trong tiêu đề, ví dụ. Bao gồm các tệp logo trong tài liệu của bạn với các kích thước để giúp người dùng dễ dàng lưu phiên bản chính xác. Đóng văn bản với một câu cảnh báo người dùng không thay đổi màu sắc, hình dạng, kích thước hoặc bố cục của logo để ngăn chặn các chỉnh sửa trái phép.

3.

Liệt kê các phông chữ cụ thể phải được sử dụng trên tất cả các trang Web của tổ chức của bạn. Bao gồm các phông chữ cho tiêu đề, tiêu đề phụ, tiêu đề, văn bản cơ thể, chú thích và trích dẫn. Đối với mỗi danh mục, hãy bố trí tên phông chữ, kích thước và cho dù đó là chữ in đậm, in nghiêng, gạch chân hoặc viết hoa.

4.

Viết về các ngoại lệ Web cho hướng dẫn kiểu ngoại tuyến của tổ chức. Bao gồm các yếu tố không phải là vấn đề với tài liệu in, chẳng hạn như cách trình bày các liên kết trong văn bản hoặc có hoặc không bao gồm các nguồn bên ngoài ở cuối trang. Nếu nhóm của bạn có phong cách trực tuyến không chính thức hơn, hãy giải thích cho người dùng cách đạt được âm báo khi viết bản sao Web.

5.

Nói cho người dùng biết màu sắc nào họ có thể sử dụng khi thiết kế trang. Liệt kê màu sắc cho từng loại văn bản, phác thảo ảnh, tiêu đề, thanh điều hướng và dấu phân cách trang. Đưa ra mã màu RGB cụ thể để đảm bảo tính nhất quán. Giải thích cho người dùng rằng màu sắc là một cách mạnh mẽ để thể hiện hình ảnh thương hiệu của bạn và cảnh báo họ chỉ sử dụng các màu đã nêu để duy trì trải nghiệm chung của người dùng.

6.

Đặt ra các quy tắc để sử dụng ảnh trên các trang Web của tổ chức. Nếu tất cả các trang của bạn có thiết kế cụ thể, hãy giải thích nơi người dùng có thể đặt ảnh. Liệt kê các kích thước pixel cần thiết cho các mục đích sử dụng khác nhau: ảnh trong văn bản, ảnh tiêu đề hoặc ảnh thanh bên chẳng hạn. Để làm cho trang web dễ tải hơn, hãy đưa ra độ phân giải hình ảnh cụ thể - đối với Web, 72 dpi là tiêu chuẩn. Yêu cầu người dùng cắt, thay đổi kích thước và chỉnh sửa hình ảnh trước khi đặt chúng vào trang web để tối ưu hóa tốc độ.

7.

Đóng tài liệu bằng cách giải thích các yêu cầu thiết kế hoặc các yếu tố thiết kế phải có trên mỗi loại trang. Bao gồm các mục như tuyên bố việc làm cơ hội bình đẳng và thông báo bản quyền và cho người dùng biết vị trí chính xác trên trang. Nếu bạn có một hình ảnh hoặc hình ảnh sẽ xuất hiện trên trang, hãy liệt kê các yêu cầu vị trí và cung cấp tệp để tải xuống ngay lập tức.