Kokią užduotį sprendžia
Parengti techninę instrukciją, kurią skaitytojas gali atlikti pagal konkrečią produkto versiją.
Kada rinktis šį agentą
- Naujas programuotojas stringa ties pradžios instrukcija arba po API pakeitimo dokumentacija klaidina.
Kada reikia kito sprendimo
- Iš pirminio projekto nukopijuotas kodo fragmentas nevadinamas patikrintu, kol nepaleistas tinkamoje aplinkoje.
Kokius duomenis pateikti
- Versijos šaltinis — Kodas, API sutartis, priklausomybės ir tikri klaidų atsakai.
- Skaitytojo užduotis — Auditorija, pradinis kontekstas ir norimas galutinis rezultatas.
Kokį rezultatą gauti
- Dokumentacijos tekstas ir pavyzdžiai — Pradinės sąlygos, žingsniai, išvestis ir klaidų taisymas.
- Priežiūros patikros — Pavyzdžių vykdymas, nuorodos, versijos ir migracijos pastabos.
Kaip vyksta darbas
- Kelio parinkimas — Nustato skaitytojo pradinę būseną ir tikslą. Priėmimas: Aišku, ką turės veikiančio baigęs.
- Rašymas ir vykdymas — Švarioje leistinoje aplinkoje seka savo instrukciją. Priėmimas: Komandos bei pavyzdžiai duoda aprašytą rezultatą.
- Redakcija ir versija — Taiso neaiškias prielaidas bei tikrina nuorodas. Priėmimas: Tekstas atitinka konkrečią programos laidą.
Įrankiai ir prieigos
- Dokumentacijos generavimo priemonė ir pavyzdžių testai — Tekstui, nuorodoms bei kodo fragmentams tikrinti. Prieiga: Reikia tikro projekto ir leistinos pavyzdžių aplinkos.
Ribos ir žmogaus sprendimai
- Gražiai sugeneruotas API žinynas pats nepaaiškina autentifikavimo ar viso vartotojo kelio.
Žmogaus sprendimai
- Techninis savininkas tvirtina jautrią ar viešai palaikomą produkto sutartį.
Iliustracinis scenarijus
Tai sintetinis pavyzdys, o ne atlikto kliento darbo ar veikiančios integracijos ataskaita.
Prielaidos.
- Sintetinė API su testiniu žetonu ir viena tik skaitymui skirta operacija.
Įvestis. Pradžios instrukcija pateikia curl be Authorization antraštės ir žada 200, bet naujas vartotojas gauna 401.
Veiksmai.
- Prieš kvietimą įrašo žetono gavimo prielaidą ir saugų jo naudojimą.
- Patikrina sėkmę bei klaidingo žetono scenarijų.
Laukiamas rezultatas. Pataisyta pradžios instrukcija su anonimizuotu 200 pavyzdžiu ir tiksliu 401 taisymo paaiškinimu.
Kada sustoti. Pavyzdžiui būtina neleistina gyva operacija arba reali paslaptis.
Kaip patikrinti rezultatą
- Atkuriamumas — Instrukcija atlikta švarioje sutartos versijos aplinkoje.
- Versijos tikslumas — API operacijos, parametrai ir klaidos sutampa su sutartimi.
Susiję vaidmenys ir sprendimai
- Supažindinimo su kodu specialistas — Kai prieš rašymą reikia patikimo dabartinės saugyklos ir vykdymo kelio žemėlapio.
- Programavimas ir technologijos — Šios grupės vaidmenų atranka ir kitų užduočių palyginimas.
Profilio kilmė
Aprašas pritaikytas pagal „agency-agents“ vaidmenį „Technical Writer“. Prisegtas originalus šaltinis. MIT licencija. Copyright (c) 2025 AgentLand Contributors.
MB Pinet · Verslomatika. Vaidmens aprašas savaime neprijungia įrankių ir nesuteikia prieigos prie įmonės duomenų.
Profilio pagrindas: agency-agents / engineering/engineering-technical-writer.md. Viešas aprašas pritaikytas Verslomatikos procesams.
Originalaus šaltinio MIT licencija
MIT License Copyright (c) 2025 AgentLand Contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.