Përmbajtje & shkrim

Shkrim teknik që njerëzit mund ta ndjekin realisht

Gjethe shkruan dokumentacion teknik për softuer, produkte dhe procese të brendshme: udhëzues përdoruesi, artikuj të qendrës së ndihmës, referenca API dhe udhëzues zhvilluesish, dokumentacion onboarding-u, shënime publikimi, procedura standarde operimi dhe baza njohurish. Shkrimtarët tanë punojnë krah zhvilluesve, testojnë çfarë dokumentojnë dhe publikojnë në mjete si GitBook, Docusaurus, Mintlify, Notion, Confluence ose helpdesk-un tuaj, në anglisht, shqip ose gjermanisht.

Rezervoni një konsultim falasKërkoni një ofertë
  • Konsultim i parë falas
  • Ofertë me shkrim për projektin tuaj
  • Faza pagese fleksibile

Me një shikim

Llojet
Udhëzues përdoruesi, dokumentim API, qendra ndihme, SOP
Platforma
GitBook, Docusaurus, Mintlify, Notion, Confluence
Formatet
Markdown, MDX, OpenAPI, HTML
Gjuhët
Anglisht, shqip, gjermanisht

Përkufizim

Çfarë është shkrim teknik?

Shkrimi teknik është zanati i shpjegimit qartë e saktë të si funksionon diçka ose si bëhet diçka, për një lexues të caktuar si klient, zhvillues ose punonjës.

Dokumentimi është pjesë e produktit. Kur mungon ose është i gabuar, klientët hapin tiketa mbështetjeje, zhvilluesit heqin dorë nga API-ja juaj e punonjësit e rinj bëjnë çdo javë të njëjtat pyetje. Dokumentimi i mirë shkruhet për një lexues në herë, testohet kundrejt produktit real e mbahet i përditësuar kur ndryshon produkti.

Për kë është?

  • Kompani SaaS

    Qendra ndihme e udhëzues onboarding-u që ulin tiketat e mbështetjes e përshpejtojnë miratimin.

  • Produkte API dhe për zhvillues

    Referenca e udhëzues që u lejojnë zhvilluesve të integrojnë pa ju shkruar me email.

  • Kompani harduerike e industriale

    Manuale, udhëzues konfigurimi e procedura mirëmbajtjeje që janë të sigurta për t'u ndjekur.

  • Ekipe në rritje

    Procedura të brendshme e dokumente onboarding-u që ruajnë si bëhet puna.

Çfarë përfshihet dhe çfarë mbani ju

Çfarë përfshihet

  • Auditim dokumentimi e analizë boshllëqesh
  • Arkitekturë informacioni e navigim
  • Udhëzues përdoruesi dhe artikuj si-të
  • Artikuj për qendrën e ndihmës
  • Referencë API nga OpenAPI ose kodi juaj
  • Quick-start e tutoriale për zhvillues
  • Shënime publikimi e changelog-e
  • Procedura standarde operative
  • Pamje ekrani, imazhe me shënime e diagrame të thjeshta
  • Udhëzues stili e shabllone për dokumente të ardhshme

Çfarë merrni

Dorëzohet në fund. Mbetet e juaja.

  • Dokumentacion i publikuar në platformën tuaj
  • Skedarë burimorë Markdown ose MDX në repozitorin tuaj
  • Një udhëzues stili për dokumentacionin
  • Shabllone për artikuj të rinj
  • Një listë kontrolli mirëmbajtjeje e lidhur me procesin tuaj të publikimit

Cilin dokumentim ju duhet?

LexuesiÇfarë u duhetFormati tipik
Klient i riKonfigurohet e arrin rezultatin e parëUdhëzues fillimi
Klient ekzistuesKryen një detyrë të veçantëArtikuj ndihme sipas detyrës
ZhvilluesIntegron shpejt e trajton gabimetReferencë API dhe quick-start
AdministratoriKonfiguron, siguron e menaxhonUdhëzues administratori
PunonjësKryen një proces njëlloj çdo herëProcedurë standarde operative

Testojmë atë që dokumentojmë

Mënyra më e shpejtë për të gjetur boshllëqe në dokumentim është ta ndjekësh. Shkruesit tanë e kalojnë çdo udhëzues në një llogari testimi ose sandbox, shënojnë ku ndryshojnë produkti e udhëzimet e ngrenë pyetje me zhvilluesit tuaj para publikimit.

Për API-të, i thërrasim endpoint-et, kontrollojmë kërkesat e përgjigjet shembull e sigurohemi që mesazhet e gabimit janë shpjeguar. Shembujt që nuk funksionojnë janë një nga arsyet kryesore pse zhvilluesit braktisin një integrim.

Dokumentacion si kod

Për produktet e zhvilluesve, dokumentimi shpesh jeton më mirë pranë kodit: Markdown ose MDX në repozitorinë tuaj, i shqyrtuar në pull request-e e i publikuar automatikisht me mjete si Docusaurus, Mintlify ose GitBook. Kjo e mban dokumentimin të versionuar me produktin e i bën përditësimet pjesë të çdo publikimi.

Për qendrat e ndihmës së klientëve, platforma e helpdesk-ut zakonisht është shtëpia e duhur, që artikujt të lidhen nga përgjigjet e mbështetjes e të kërkohen nga produkti.

Dokumentim që asistentët AI mund ta lexojnë

Klientët pyesin gjithnjë e më shpesh ChatGPT, Claude ose bot-in tuaj të mbështetjes si ta përdorin produktin tuaj. Titujt e qartë, një detyrë për artikull, parakushtet e shprehura dhe shembujt e saktë e bëjnë dokumentimin më të lehtë për t'u cituar saktë nga këto mjete. Mund të publikojmë edhe një indeks llms.txt të dokumentimit tuaj që mjetet AI të gjejnë faqet e duhura.

Shenja që dokumentimi juaj ka nevojë për punë

  • Mbështetja i përgjigjet çdo javë të njëjtave pyetje si-të
  • Pamjet e ekranit tregojnë një version të vjetër të produktit
  • Zhvilluesit kërkojnë shembuj në thirrjet e shitjes
  • Punonjësit e rinj i mësojnë proceset duke pyetur përreth
  • Askush nuk e ka përgjegjësi përditësimin e dokumentimit pas një publikimi
  • Kërkimi në qendrën e ndihmës rrallë e gjen përgjigjen

Shënime publikimi që i lexojnë klientët

Shënimet e publikimit shpesh shkruhen për ekipin që ndërtoi veçorinë. Klientët duan të dinë çfarë ndryshoi për ta, nëse duhet të bëjnë diçka dhe ku të mësojnë më shumë. Shkruajmë shënime publikimi që fillojnë me përfitimin, shpjegojnë çdo veprim të nevojshëm e lidhen me artikullin e përditësuar të ndihmës.

Për produktet e zhvilluesve, mbajmë paralelisht një changelog të saktë: versione, ndryshime që prishin, çaktivizime e hapa migrimi, që integruesit të përditësojnë pa befasi.

Si funksionon shkrimi teknik, hap pas hapi

Çdo hap ka një rezultat të qartë që mund ta shqyrtoni. Afatet dakordësohen në ofertën tuaj.

  1. 1

    Auditimi

    Shqyrtojmë dokumentacionin ekzistues, tiketat e mbështetjes dhe analitikën për të gjetur boshllëqe.

  2. 2

    Struktura

    Lexuesit, temat dhe navigimi dakordësohen para shkrimit.

  3. 3

    Shkrimi dhe testimi

    Drafte të shkruara duke ndjekur çdo hap në produkt.

  4. 4

    Shqyrtim

    Shqyrtim teknik nga ekipi juaj, pastaj redaktim për qartësi.

  5. 5

    Publiko

    Publikohet në platformën tuaj me shabllone për artikuj të ardhshëm.

  6. 6

    Mirëmbajtja

    Përditësime opsionale të lidhura me procesin tuaj të publikimit.

Mjetet dhe çfarë e formëson ofertën tuaj

Çmimi bazohet në projektin tuaj dhe bihet dakord në ofertën tuaj. Këto janë gjërat që e lëvizin atë.

Shkrim teknik: faktorët e çmimit
FaktoriPse ka rëndësi
Numri i artikujve ose faqeveMë shumë tema nënkuptojnë më shumë kërkim, shkrim e shqyrtim.
Thellësia teknikeDokumentimi i API-ve e zhvilluesve kërkon më shumë testim se udhëzuesit e përdoruesit.
Qasja te ekspertëtPërgjigjet e shpejta nga ekipi juaj e mbajnë punën efikase.
PamjetPamjet e ekranit, imazhet me shënime e diagramet shtojnë kohë prodhimi.
GjuhëtÇdo gjuhë shtesë kërkon përkthim e shqyrtim.
Konfigurimi i platformësKonfigurimi i një platforme të re dokumentimi shton punë fillestare.

Gabime të zakonshme që duhen shmangur

Çfarë shohim që shkon keq më shpesh dhe si e shmang një projekt i mirë.

  • Shkrimi për të gjithë njëkohësisht

    Një faqe për fillestarë dhe ekspertë nuk i shërben asnjërit. Shkruani për një lexues për faqe.

  • Dokumentimi i funksioneve në vend të detyrave

    Njerëzit vijnë me një punë për të bërë. Organizoni sipas asaj që duan të arrijnë.

  • Shembuj që nuk ekzekutohen

    Shembujt e prishur të kodit e shkatërrojnë besimin më shpejt se dokumentacioni që mungon.

  • Pa pronar pas publikimit

    Dokumentacioni vjetrohet brenda disa publikimeve nëse përditësimi i tij nuk është pjesë e publikimit.

Pyetje të shpeshta

A i kuptojnë shkruesit tuaj produktet teknike?

Po. Shkruesit tanë punojnë çdo ditë me zhvillues, lexojnë kod e API dhe testojnë atë që dokumentojnë në vetë produktin.

A mund të shkruani dokumentim API nga skedari ynë OpenAPI?

Po. Përdorim specifikimin tuaj OpenAPI si burim për referencën e shtojmë udhëzues, shembuj e shpjegime gabimesh përreth.

Në cilat platforma publikoni?

GitBook, Docusaurus, Mintlify, ReadMe, Confluence, Notion e baza njohurish të helpdesk-ut, ose Markdown i thjeshtë në repozitorinë tuaj.

A mund të dokumentoni procese të brendshme?

Po. Shkruajmë procedura standarde operative e udhëzues onboarding-u duke intervistuar njerëzit që e bëjnë punën e duke testuar hapat.

A përktheni dokumentim?

Shkruajmë në anglisht, shqip e gjermanisht dhe mund të prodhojmë gjuhë të tjera përmes përkthyesve profesionistë.

A mund ta mbani dokumentimin tonë të përditësuar pas çdo publikimi?

Po. Mund t'i shqyrtojmë shënimet e publikimit e t'i përditësojmë faqet e prekura si pjesë e një marrëveshjeje të vazhdueshme.

A përdorni AI për të shkruar dokumentim?

Mund të përdorim AI për skica ose përmbledhje të para, por çdo faqe shkruhet, testohet e kontrollohet nga një person kundrejt produktit real.

Si çmohet shkrimi teknik?

Ofrohet sipas numrit të faqeve, thellësisë teknike, vizualeve e gjuhëve, pasi shqyrtojmë atë që ekziston.

A mund të punoni nga regjistrime ekrani e thirrje me zhvilluesit tanë?

Po. Regjistrime të shkurtra ose thirrje me njerëzit që ndërtuan një veçori shpesh janë mënyra më e shpejtë për të nisur, e i kthejmë në udhëzues të strukturuar e të testuar.

A shkruani tekst brenda produktit si tooltip-e e mesazhe gabimi?

Po. Mikrotekstet lidhen ngushtë me dokumentimin, dhe mbajtja e formulimit të qëndrueshëm mes produktit e dokumentimit i ndihmon përdoruesit.

A mund ta migroni dokumentimin tonë në një platformë të re?

Po. Zhvendosim e rirenditim përmbajtjen ekzistuese, rregullojmë lidhjet e prishura e konfigurojmë ridrejtime që URL-të e vjetra të funksionojnë ende.

Shërbime të ngjashme

Të gjitha shërbimet e përmbajtjes & shkrimit

Lexim i mëtejshëm

Të gjithë udhëzuesit

Shkrimi teknik sipas industrisë

Bëjeni produktin tuaj më të lehtë për t'u përdorur.

Na tregoni çfarë ju duhet. Merrni një vlerësim të sinqertë, një plan të qartë dhe një ofertë me shkrim. Konsultimi i parë është gjithmonë falas.

Rezervoni një konsultim falasKërkoni një ofertë
  1. Çfarë ndodh më pas
  2. 1Na tregoni çfarë ju nevojitet
  3. 2Synojmë t'ju përgjigjemi brenda 24 orëve me pyetje
  4. 3Merrni një ofertë me shkrim për projektin tuaj