Free Press

Reiau de unde am rămas în partea 1 a seriei de instrumente de scriere tehnică. (Verificați-o dacă nu ați citit-o)
În această tranșă, ne ocupăm de instrumentele de scriere tehnică utilizate în faza de „Documentare a informațiilor”.
Aceasta este faza de scriere, editare, desenare, revizuire și rescriere. Aceasta este faza în care echipa de documentare a informației este la putere maximă, producând ghiduri, manuale, bloguri, demonstrații video, pagini de ajutor online și câte și mai câte. Având în vedere varietatea sarcinilor din această fază, instrumentele de scriere tehnică utilizate sunt, de asemenea, destul de diverse și nenumărate.

Top 17 instrumente software de scriere tehnică pentru documentație în 2020

• • Whatfix
  • MediaWiki
  • Adobe Robohelp

• Notepad++
• WordPress
• Adobe Photoshop
• Adobe Illustrator
• Adobe Illustrator

.

• Microsoft Visio
• Windows Snipping Tool
• Windows Movie Maker
• Powtoon
• Prezi
• Microsoft Word
• Kingsoft WPS Office
• Google Docs
• Adobe Framemaker
• oXygen XML Author

1. Whatfix

Whatfix semnifică o schimbare de paradigmă în modul în care este prezentată documentația de ajutor online. Paginile de ajutor web statice și lungi nu captează atenția utilizatorului la fel de eficient ca ghidurile interactive, ilustrate, prezentate de Whatfix, denumite popular „baloane”.
În plus, în lumea de astăzi, ajutorul online trebuie să se răspândească pe diverse gadgeturi – fie că este vorba de PC-uri, tablete sau smartphone-uri. Whatfix adaptează automat conținutul de ajutor în funcție de gadget. Iar același conținut de ajutor poate fi accesat în diferite forme – sub formă de slideshow, PDF sau video.
Consiliu al autorului: Whatfix suportă o caracteristică unică – Real-time Interactive walkthrough – prin care puneți fragmente de ajutor direct în pagina live a produsului! Utilizatorul citește fragmentul în balonul Whatfix și efectuează acțiunea corespunzătoare pe pagină. Acesta este un instrument de scriere tehnică popular printre afacerile care caută o schimbare față de metodologiile tradiționale.

MediaWiki

Afișarea ajutorului online al produsului dvs. ca pagini wiki este o idee simplă și eficientă. Paginile dvs. pot fi integrate direct în Wikipedia, dacă nu aveți un site web separat pentru produsul dvs. online. Alternativ, puteți găzdui pagini de ajutor de tip wiki pe site-ul web al produsului dumneavoastră. Familiaritatea ridicată a acestui format în rândul utilizatorilor online este un avantaj cheie, iar instrumentul gratuit de editare wiki MediaWiki Visual Editor face ca crearea de ajutor să fie destul de simplă.
MediaWiki este un instrument de editare web bazat pe PHP, pe care îl folosește Wikipedia. Cu toate acestea, chiar și marile corporații de software, Intel fiind un exemplu cheie, folosesc acest instrument pentru a-și prezenta informațiile de vânzări și marketing, How To’s și paginile de ajutor privind politica și procedurile.
Consiliul autorului: Acest instrument de tehnoredactare vine cu un bun suport pentru extensii – pentru conținut în mai multe limbi, revizuire colaborativă, urmărirea editărilor, căutare încorporată etc.

Adobe RoboHelp

Un instrument de autor standard în industrie, utilizat pentru a crea sisteme de ajutor pentru aplicații desktop sau web. Niciun utilizator de calculator nu este străin de RoboHelp! De fiecare dată când apăsați F1 în oricare dintre aplicațiile software standard, fereastra de ajutor care apare este aproape întotdeauna creată cu ajutorul RoboHelp. Cu toate acestea, el poate fi folosit și pentru a produce documentația tehnică convențională pentru tipar, cum ar fi ghidurile și manualele.
Individualul sofisticat RoboHelp IDE permite redactorilor tehnici să dezvolte proiecte de ajutor pe scară largă și să le redea pe mai multe dispozitive hardware/sisteme de operare și în mai multe formate (PDF, HTML, DOC, etc.). Versiunea mai veche a RoboHelp poate fi achiziționată ca ediție low-cost dacă bugetul reprezintă o constrângere. Cu toate acestea, companiile mici se pot limita la alternative simple și gratuite, cum ar fi blogurile WordPress sau Wikis. Bătrânul și bunul MS Word poate, de asemenea, să genereze pentru dumneavoastră fișiere de ajutor HTML de bază.
Consiliu al autorului: Gestionarea produselor software mari, cu versiuni de actualizare regulate, poate fi o provocare majoră pentru redactorii tehnici, deoarece aceștia trebuie să fie sincronizați cu istoricul modificărilor produsului. Fișierele de ajutor prezintă adesea variabile configurabile definite de utilizator care se repetă de mai multe ori în întreaga documentație de ajutor. (De exemplu, o variabilă precum „Sleep time after inactivity” (Timp de veghe după inactivitate) este setată la 30 de secunde în versiunea anterioară, urmând să fie setată la 1 minut în versiunea actualizată). Proiectul RoboHelp s-ar ocupa de actualizarea valorii variabilei în toate fișierele de ajutor!

Notepad++

Un editor HTML foarte eficient pentru începători. Majoritatea oamenilor învață elementele de bază ale programării HTML pe acest instrument de scriere tehnică. Dacă produsul dvs. software nu necesită o documentație de ajutor online foarte stufoasă, pentru realizarea unor fișiere de ajutor de dimensiuni medii, acest instrument este mai mult decât suficient.
Instrumentul său de interfață grafică personalizabilă permite o editare ușoară, suportă WYSIWYG pentru imprimare și are, de asemenea, opțiuni de suport pentru mai multe limbi.
Sfatul autorului: Notepad++ vine cu un set bogat de plug-in-uri. Multi-clipboard, Code Compare, Auto-Save sunt câteva dintre cele mai populare. Redactorii tehnici trebuie să aleagă setul potrivit de plug-in-uri, care pot transforma un editor obișnuit pentru începători într-o opțiune viabilă pentru editarea de ajutor online.

WordPress

Locul de referință dacă doriți să aveți documentație tehnică pentru produsul dumneavoastră sub formă de bloguri. WordPress este o platformă de gestionare a conținutului online, gratuită și cu sursă deschisă. Blogurile scrise pe WordPress pot fi accesate fie direct de la URL-ul blogului WordPress, fie pot fi integrate în site-ul companiei dumneavoastră.
Acest articol în sine este găzduit pe blogul WordPress numit Whatfix Academy. Dacă obiectivul este de a publica în mod regulat conținut online despre compania dvs. / tehnologiile asociate, atunci înființați un cont de blog WordPress. De asemenea, blogurile pot capta răspunsurile utilizatorilor sub formă de comentarii și aprecieri, ceea ce face mai ușor să vă implicați cu publicul dvs. țintă și să simțiți aprecierea acestuia pentru produsul dvs.
Consiliul autorului: Este posibil ca blogurile în mod izolat să nu adune suficiente ochi. Așadar, mai întâi scrieți blogul, apoi promovați blogul pe platformele de social media și, în final, măsurați numărul de vizualizări/răspunsuri înainte de a trece la următorul set de bloguri!
Citește și: Cum se schimbă redactarea tehnică odată cu vremurile

Adobe Photoshop

Un instrument pe care majoritatea redactorilor tehnici din întreaga industrie îl jură. Este cel mai popular instrument de editare a imaginilor din lume pentru crearea și editarea fotografiilor și a lucrărilor artistice bazate pe raster (pixel). Poate fi folosit pentru a crea modele de interfețe utilizator, pagini web, bannere publicitare, grafică video, editarea de imagini pentru imprimare. Manipularea unei imagini, suprapunerea unei imagini pe alta, rafinarea unei fotografii pentru a elimina imperfecțiunile, corectarea problemelor de iluminare sunt cele mai populare utilizări ale sale. Procesul de editare a imaginilor este reversibil și incremental, astfel încât modificările pot fi reluate cu ușurință.
Consiliu al autorului: Pentru designerii profesioniști, care au nevoie în mod constant de un instrument de editare a imaginilor, aproape că nu există un înlocuitor pentru Adobe Photoshop. Cu toate acestea, dacă sunteți un utilizator ocazional, încercați GIMP, care este open source. Acesta suportă doar scheme de culori RGB, în timp ce Photoshop suportă și modul de culori CMYK (CYAN YELLOW MAGENTA BLACK). Și curba de învățare este mai mare pentru GIMP, dar este gratuit, în timp ce Photoshop costă o bombă!”

Adobe Illustrator

Un instrument pentru crearea și editarea ilustrațiilor bazate pe vectori, cum ar fi logo-uri și mărci de marcă sau alte elemente de design. Designerii grafici fac adesea greșeala de a proiecta logo-urile produselor lor pe Photoshop. Dar același logo trebuie să fie tipărit pe cărți de vizită, precum și pe panouri publicitare masive. Așadar, redimensionarea imaginii fără a pierde claritatea este cheia aici, lucru pe care instrumentele de imagistică bazate pe grafică vectorială îl realizează. Adobe Illustrator și Corel Draw sunt cele mai importante instrumente de scriere tehnică scriere tehnică în acest spațiu.
Consiliu al autorului: Acest instrument face parte din soluția Adobe Creative Cloud cu închirieri lunare costisitoare. Instrumentele de scriere tehnică alternative gratuite, precum Inkscape sau Affinity Designer, pot face treaba la fel de bine cu formatele SVG. Cu excepția cazului în care aveți nevoie de toate instrumentele majore de scriere tehnică care fac parte din această soluție (Photoshop, InDesign etc.), acest instrument nu este o necesitate.

Microsoft Visio

Un instrument popular de creare de diagrame utilizat în proiectarea aplicațiilor de inginerie. Redactorii tehnici trebuie adesea să proiecteze diagrame de flux, diagrame arhitecturale, diagrame de circuite electrice, proiectare de produse software și așa mai departe. Visio este un ajutor convenabil pentru acest lucru.
Este un instrument de scriere tehnică conform IEEE care respectă standardele industriei de software, cum ar fi UML (Unified Modeling Language) și BPMN (Business Process Model and Notation).
Sfatul autorilor: Visio nu a făcut parte din suita tradițională Microsoft Office, a fost întotdeauna vândut separat, similar cu MS Project. Dar un anunț foarte recent de la Microsoft spune că abonații online ai Office 365 pot accesa acum și Visio.

Windows Snipping Tool

Dacă sunteți în căutarea unor opțiuni de capturare a ecranului care sunt mai sofisticate decât PrntScr de pe tastatură, Snipping Tool este o alegere bună. În afară de capturarea întregului ecran, puteți, de asemenea, să capturați capturi cu mâna liberă, sau capturi parțiale ale zonei de ecran. Pentru a captura imagini statice din videoclipuri, utilizați opțiunea de întârziere, astfel încât cadrul exact să poată fi salvat ca imagine.
Sfatul autorului: Face parte din suita de software Windows, dar este posibil să nu fie activat în mod implicit în unele ediții de Windows.

Windows Movie Maker

Un instrument simplu de editare video pe care redactorii tehnici îl pot utiliza pentru a realiza videoclipuri demonstrative ale produselor lor. Face parte din suita Windows Essentials. Cu toate acestea, din ianuarie 2017, acest software a fost întrerupt, fără a fi anunțat un înlocuitor adecvat. Așadar, toți acei utilizatori cu versiuni mai vechi de Windows, mulțumiți stelei norocoase!
Consiliu pentru autori: Clipurile video și audio pot fi aranjate și editate într-o vizualizare de tip storyboard, cadru cu cadru. Sau o serie de imagini fixe pot fi întinse pe o linie de timp. Voiceovers audio îmbinate cu sunete de fundal pot da videoclipurilor dvs. un plus de sofisticare.

Powtoon

Scrisul tehnic devine din ce în ce mai mult vizual. Videoclipurile animate sunt o modalitate excelentă de a capta atenția utilizatorilor și de a transmite mesajul într-un mod atractiv. Powtoon este un bun instrument de animație bazat pe web, vândut ca un produs SaaS. Prezentările animate și videoclipurile explicative pot fi create cu ajutorul acestui instrument gratuit. Cu toate acestea, videoclipurile create cu versiunea gratuită ar purta un filigran „Powtoon”.
Sfatul autorului: Dacă redactarea tehnică nu este în scopuri oficiale, este perfect OK să folosiți versiunea gratuită a acestui instrument. Cu toate acestea, o chirie nominală, ați putea obține versiunea premium care vă permite să creați videoclipuri fără filigranul de apă și alte câteva caracteristici.

Prezi

O abordare neconvențională a realizării de demonstrații sub forma unei prezentări video. Spre deosebire de Powerpoint, unde conținutul este împărțit în mod rigid în diapozitive, Prezi vă oferă doar o singură pânză albă masivă. Puteți să vă apucați să scrieți, să desenați pe el după bunul plac. Apropierea sau îndepărtarea de conținutul vizat și schimbarea focalizării de la un cadru la altul pe aceeași pânză – este modul în care realizați o prezentare video continuă.
Consiliul autorilor: În afară de versiunea gratuită, există o versiune de încercare pentru studenți, de asemenea gratuită, care are aproape toate caracteristicile versiunii cu plată. Alege-o pe aceea.
Citește și – 14 concepții greșite de tehnoredactare pe care ar trebui să le știi!

Microsoft Word

Se pare destul de prostesc să scriu despre omniprezentul MS Word. Dar, oricât de banal ar fi în viața noastră digitală de zi cu zi, se întâmplă să fie totuși cel mai bun prieten al unui redactor tehnic! Cu o conversie facilă între formatele PDF și DOC, combinația simplă dintre Word și Adobe Acrobat Reader nu trebuie luată cu ușurință. Acest articol ar putea fi despre toate instrumentele de scriere tehnică sofisticate din lume, dar este scris folosind – umilul MS Word!
Consiliu pentru autori: Experimentați cu diferitele șabloane de documente pe care le oferă Word. Acestea vă ajută să faceți ca documentul dvs. să aibă un aspect adecvat scopului urmărit – ca pliante de marketing, whitepaper-uri tehnice, ghiduri de depanare și așa mai departe.

Kingsoft WPS Office

MS Word, PowerPoint și Excel sunt cunoscute ca fiind cele mai utilizate instrumente software de scriere tehnică, cu mult înaintea alternativelor disponibile. Doar revoluția Android a încetinit puțin juggernautul MS Office. Și a dat un loc de frunte lui Kingsoft Office, o alternativă rezonabilă și gratuită la MS Office.
Consiliul autorilor: Există câteva funcții nuanțate pe care WPS Writer nu le suportă – Thesaurus fiind una dintre ele. Tezaurul este o caracteristică importantă pentru scriitorii tehnici, deoarece suntem în mod constant în căutarea unor cuvinte mai bune pentru a exprima aceleași puncte în diferite documente tehnice!

Google Docs

Într-o lume care apelează din ce în ce mai mult la un telefon mobil la îndemână pentru a citi documente, mai degrabă decât să își ia osteneala de a porni calculatorul, Google Docs câștigă încet-încet proeminență. Crearea de documente de la zero nu ar fi convenabilă pe Google Docs, dar revizuirea și editarea colaborativă se poate face în mod eficient prin intermediul acestei alternative bazate pe cloud la MS Office.
Sfatul autorului: Integrarea sa perfectă cu Gmail și Google Drive îl face și mai atractiv. În calitate de redactor tehnic, ați rămâne la instrumentele sofisticate de procesare a textelor. Dar managerul dvs. de produs care s-ar putea să fie tot timpul în mișcare este sigur că va recupera recenziile pe telefon, după toate probabilitățile!

Adobe Framemaker

Un procesor de documente sofisticat pentru documente mari, standard industriale. Poate fi folosit pentru a genera documente structurate cu un cadru XML, cu o conformitate 100% DITA. Poate fi utilizat și pentru documente nestructurate, ca înlocuitor al editorilor de documente precum MS Word.
Framemaker este o alegere bună pentru generarea de documente structurate cu șabloane predefinite pentru a respecta mai multe formate standard industriale – cum ar fi acordurile legale și situațiile financiare. Suportă crearea de TOC sau index în mai multe documente, are opțiuni bogate de formatare. Nu scade în performanță atunci când sunt inserate elemente grafice.
Consiliu al autorului: Framemaker este o investiție solidă pentru companiile consacrate, cu echipe formale de redactare tehnică, care trebuie să producă documente mari, de peste 100 de pagini. Cu toate acestea, companiile cu un singur produs și start-up-urile nu trebuie să facă această investiție. Există instrumente gratuite de creare de documente bazate pe XML disponibile gratuit. Și puteți apela oricând la vechiul și bunul MS Word!

oXygen XML Author

Este un editor XML gratuit, open source, compatibil DITA, cu mai mulți utilizatori loiali și recenzii bune. DITA (Document Information Typing Architecture) este un standard deschis pentru crearea și publicarea de documente, care și-a făcut încet-încet loc în gestionarea documentelor tehnice. Pur și simplu pentru că elimină dependența editării conținutului de un anumit instrument. Dacă produceți o documentație online conformă cu DITA (un set de fișiere XML), atunci editarea și întreținerea ei în viitor ar fi posibilă prin orice alt instrument compatibil cu DITA!
Din moment ce specificațiile DITA sunt un domeniu care necesită o atenție specială, permiteți-mi să păstrez acest lucru pentru un alt articol.
Sfatul autorului: Este suficient să spunem că suita de instrumente oXygen este o alternativă viabilă la extrem de popularul, dar prohibitiv de scump, Adobe Framemaker. oXygen Author este în general utilizat în combinație cu oXygen Developer.
Acum, acesta este tot software-ul de scriere tehnică de care veți avea nevoie în faza de „Informații despre document”. Următoarea și ultima parte va prezenta faza „Publicarea informațiilor”.
Pentru a afla câteva sfaturi excelente de scriere tehnică și pentru a vă asigura că nu pierdeți actualizările noastre privind instrumentele de scriere tehnică, abonați-vă la blogul nostru.
Vă place? Marcați articolul sau partajați-l cu prietenii și colegii dvs.!

Noi, la Whatfix, inovăm spațiul instrumentelor de scriere tehnică prin întreruperea ideii însăși de conținut scris continuu de lungă durată. Ghidurile noastre interactive vă vor ajuta să deveniți mai productivi, oferindu-vă o modalitate rapidă și eficientă de a crea documentație tehnică. Citiți mai multe despre modul în care Whatfix ajută la scrierea tehnică în acest articol.

.