Hướng dẫn - Làm thế nào để cập nhật?

Nếu bạn có một sản phẩm đã có mặt trên thị trường trong một thời gian dài, nhưng nó vẫn đang được phát triển tích cực hàng ngày - các hướng dẫn nên được cập nhật thường xuyên như thế nào? Nếu người dùng của bạn liên tục được cập nhật lên phiên bản mới nhất do thực tế là tổ chức của bạn thấy phù hợp thì các bản sửa lỗi mới nhất luôn có trong phiên bản giao hàng. Có nghĩa là, bạn có thể sửa một lỗi một ngày và ngày hôm sau nó đang được sản xuất.

Tôi sẽ cập nhật hướng dẫn:

1. Đối với mỗi bản phát hành chính, và
2. Khi các tính năng mới quan trọng trở nên ổn định và đủ trưởng thành mà bạn biết rằng chúng sẽ không thay đổi cứ sau năm phút.

cập nhật hướng dẫn (PDF) bất cứ khi nào thay đổi mã sẽ thay đổi hướng dẫn trong hướng dẫn - chỉ cần thực hiện cập nhật phần thủ công của quy trình phát hành

nếu người dùng dựa vào hướng dẫn để cho họ biết cách sử dụng sản phẩm và sản phẩm thay đổi, thì điều thông thường là các phần có liên quan của hướng dẫn cũng sẽ thay đổi

Trong năm 2010 chúng ta vẫn đề cập đến tài liệu in? Tại sao? ;)

Nói một cách nghiêm túc, tài liệu (trợ giúp ứng dụng "F1", PDF hoặc tài liệu trực tuyến) phải là một phần của mỗi bản phát hành. Không có lý do. Thật đơn giản để "xuất bản." Như một vấn đề thực tế, IMO, không có lý do gì để không cập nhật tài liệu một cách thường xuyên (trực tuyến và PDF), ngay cả giữa các bản phát hành, ngay khi các vấn đề được biết và sửa chữa. Nó không cần cùng mức QA - thậm chí không gần.

Tôi giả sử bạn đang nói về tài liệu người dùng cuối. Viết tài liệu là một nỗi đau trong @ $$ và trong khi tôi đã phát triển một số kỹ thuật để thuyết phục tôi về nghịch đảo, tôi vẫn gặp vấn đề với điều đó. Đây là cách tôi cố gắng quản lý nó:

Tích hợp cập nhật tài liệu trong DoD của bạn ( Định nghĩa hoàn thành )

Điều này sẽ đảm bảo rằng tài liệu của bạn sẽ được cập nhật vào cuối mỗi lần hoàn thành câu chuyện của người dùng.

Dưới đây là định nghĩa của chúng tôi đã viết. Tôi đã cố gắng để giữ các định dạng ban đầu, để bạn có được ý tưởng. Đó là một trang A4 được đặt trên bảng trắng.

---------- 8 <------------ Cắt ở đây ------------ 8 <----------

Không thể thương lượng

Định nghĩa của Done Done

• Mã với phạm vi kiểm tra đơn vị 80%, được cam kết trong kho lưu trữ

• Ảnh chụp màn hình nếu có (1024x728, 395x281, 170x121 & 729x329)

• Mô tả tính năng nếu có (50 ký tự, 100 ký tự)

• Tài liệu người dùng cuối đầy đủ

• Tập tin mới được cập nhật đúng cách

---------- 8 <------------ Cắt ở đây ------------ 8 <----------

Tất nhiên bạn có thể thêm một quá trình xem xét trong tài liệu. Chúng tôi có điều đó vì không ai trong chúng tôi là người nói tiếng Anh bản ngữ.

Một trong những lợi thế của Định nghĩa Hoàn thành như thế này là sản phẩm của bạn có khả năng chuyển đổi được vào cuối mỗi lần hoàn thành câu chuyện của người dùng.

Sử dụng kỹ thuật này kết hợp với cái này .

Trong tổ chức của tôi, chúng tôi thường có 3 loại phát hành:

1. Phát hành Kỹ thuật - về cơ bản sửa chữa nóng cho một số khách hàng cụ thể hoặc một số tính năng chỉ một khách hàng cụ thể đã yêu cầu trên cơ sở ngay lập tức.
2. Bản phát hành nhỏ - sửa lỗi, hỗ trợ gia tăng
3. Phát hành chính - hỗ trợ tính năng mới, v.v.

Theo định nghĩa, Bản phát hành chính phải có tài liệu liên quan thay thế cả trực tuyến và ngoại tuyến. Hệ thống theo dõi của chúng tôi đảm bảo rằng tài liệu là một phần của danh sách kiểm tra.

Bản phát hành nhỏ chỉ cần tài liệu về bất cứ điều gì mới đã được thêm vào ở cấp độ nhận thức của người dùng. Vì vậy, nếu bạn đã bao gồm một heuristic khác có thể làm giảm độ phức tạp thời gian trong một số tình huống cụ thể, nó có thể hoặc không phải là một cuộc gọi quan trọng để đưa nó vào pdf.

Phát hành kỹ thuật có thể làm mà không cần tài liệu. Một số lưu ý sử dụng không chính thức nên đủ tốt để bắt đầu.

Tài liệu phải đồng bộ với bất kỳ phần mềm nào bạn đang giao cho khách hàng. Bất kỳ trận đấu sai nào khác sẽ cung cấp cho bạn các vấn đề. Và nếu bạn không có một nhà văn trong đội ngũ nhân viên, hãy thử các nhà thầu. Một khi bạn tìm thấy một cái bạn thích, giữ anh ta trên người giữ.