Як спростити опис дій в інтерфейсі

Одна з головних якостей хорошої документації – неперекладна brevity. Це – філологічний термін, яким називають чітке, коротке та зрозуміле використання слів.

В документації, зокрема юзергайдах, brevity заважає занадто довгий опис взаємодії з елементами в інтерфейсі:

To upload your documents, click the Upload button

Натомість,

To upload documents, select Upload.

• потребує менше тексту
• описує ту ж саму дію
• підходить до (майже) всіх елементів

(Майже, бо: іноді кнопки з релізами стають опціями списку; чого не скажеш за статичні елементи типу Actions чи Settings, які постійно в одному куті і їх потрібно саме click)

І, звісно, не варто забувати, що Press — клавіша клавіатури; Click — елемент десктоп-інтерфейсу; Tap — елемент мобільного інтерфейсу.

Докладніше про це написали в Майкрософті.