Docs for Developers: An Engineer's Field Guide to Technical Writing
Learn to integrate programming with good documentation. This book teaches you the craft of documentation for each step in the software development lifecycle, from understanding your users' needs to publishing, measuring, and maintaining useful developer documentation.Well-documented projects save... Lue lisää
Learn to integrate programming with good documentation. This book teaches you the craft of documentation for each step in the software development lifecycle, from understanding your users' needs to publishing, measuring, and maintaining useful developer documentation.Well-documented projects save... Lue lisää
Learn to integrate programming with good documentation. This book teaches you the craft of documentation for each step in the software development lifecycle, from understanding your users' needs to publishing, measuring, and maintaining useful developer documentation.Well-documented projects save time for both developers on the project and users of the software. Projects without adequate documentation suffer from poor developer productivity, project scalability, user adoption, and accessibility. In short: bad documentation kills projects.
Docs for Developers demystifies the process of creating great developer documentation, following a team of software developers as they work to launch a new product. At each step along the way, you learn through examples, templates, and principles how to create, measure, and maintain documentation--tools you can adapt to the needs of your own organization.
What You'll Learn
Create friction logs and perform user research to understand your users' frustrationsResearch, draft, and write different kinds of documentation, including READMEs, API documentation, tutorials, conceptual content, and release notesPublish and maintain documentation alongside regular code releasesMeasure the success of the content you create through analytics and user feedbackOrganize larger sets of documentation to help users find the right information at the right time Who This Book Is For
Ideal for software developers who need to create documentation alongside code, or for technical writers, developer advocates, product managers, and other technical roles that create and contribute to documentation for their products and services.
Docs for Developers demystifies the process of creating great developer documentation, following a team of software developers as they work to launch a new product. At each step along the way, you learn through examples, templates, and principles how to create, measure, and maintain documentation--tools you can adapt to the needs of your own organization.
What You'll Learn
Create friction logs and perform user research to understand your users' frustrationsResearch, draft, and write different kinds of documentation, including READMEs, API documentation, tutorials, conceptual content, and release notesPublish and maintain documentation alongside regular code releasesMeasure the success of the content you create through analytics and user feedbackOrganize larger sets of documentation to help users find the right information at the right time Who This Book Is For
Ideal for software developers who need to create documentation alongside code, or for technical writers, developer advocates, product managers, and other technical roles that create and contribute to documentation for their products and services.
- Kustantaja / Valmistaja Apress
- ISBN 9781484272169
- Tuotekoodi 9781484272169
- Kirjoittajat Jared Bhatti; Jen Lambourne; Sarah Corleissen
- Kieli Englanti
- Ilmestymispäivä 01.10.2021
- Vuosi 2021
- Tuoteryhmä Ulk talous, it, yhteiskunta
- Tuotepääryhmä Ulkomaiset kirjat
- Tuotelinja Kirjat
- Sivumäärä 225
- Avainsanat Programming - Open Source; Programming - Open Source; Internet - Web Programming; Internet - Web Programming
- Kirjastoluokka COM
- Pituus (mm) 234
- Leveys (mm) 156
- Korkeus (mm) 13
- Paino (g) 358
- Tuotemuoto Pehmeäkantinen
- Tuotemuodon lisätiedot Trade pokkari (US)
Tämä tuote kuuluu tuoteryhmiin
Lue lisää tuotearvosteluista
Tuotearvostelut Suomalainen.comissa
Tutustu tuotearvostelujen käytäntöihin ja ehtoihin ennen kuin jätät arvostelun.
Suomalainen.com -verkkokaupassa on mahdollista jättää tuotearvosteluja siellä myynnissä olevista tuotteista. Tuotearvosteluja voivat jättää sekä tuotetta Suomalaisesta Kirjakaupasta ostaneet asiakkaat että muut sivuston käyttäjät. Arvostelijan nimimerkin jälkeinen teksti kertoo, onko kyseessä vahvistettu ostaja vai muu asiakas/sivuston käyttäjä.
-
Vahvistettu ostaja - Kyseinen arvostelu on jätetty käyttämällä tuotteen ostajalle lähetettyä sähköpostilinkkiä. Kyseessä on siis vahvistettu ostaja eli arvostelun jättänyt henkilö on ostanut todennetusti kyseisen tuotteen.
-
Vahvistettu suosittelija - Kyseinen arvostelu on jätetty suomalainen.com -verkkosivustolla. Arvostelijan sähköpostiosoite on vahvistettu, jotta on voitu varmistua siitä, että arvostelun on jättänyt oikea henkilö. Suomalainen.com ei kuitenkaan ole vahvistanut, että kyseinen henkilö on ostanut tuotteen.
- Ei tekstiä nimimerkin jälkeen - Kyseinen arvostelu on jätetty suomalainen.com -verkkosivustolla, mutta arvostelun jättäjän sähköpostiosoitetta ei ole vahvistettu.
Tuotearvostelussa pakollisia tietoja ovat tuotteen pistemäärä (tähdet), otsikko sekä arvosteluteksti. Jos jätät arvostelun sinulle lähetetyn sähköpostilinkin kautta, arvostelu julkaistaan käyttämällä etunimeäsi sekä sukunimen ensimmäistä kirjainta.
Jos jätät arvostelun sivustollamme, voit käyttää arvostelussa myös nimimerkkiä. Arvostelun jättämisen yhteydessä sinulta kysytään sähköpostiosoitetta, jonka avulla vahvistamme, että arvostelun on lähettänyt oikea henkilö, eikä esimerkiksi robotti. Tuotearvostelujen palveluntarjoajana toimii Yotpo. Katso Yotpon tietosuojaseloste.
Arvostelut julkaistaan tuotteen kohdalla automaattisesti ja ne tulevat esiin viiveellä. Suomalainen.com pidättää kuitenkin oikeuden poistaa kommentit, jotka sisältävät epäasiallista, herjaavaa tai halventavaa kieltä, vihapuhetta tai ovat muuten hyvän tavan vastaisia, tai joissa markkinoidaan muiden toimijoiden sivustoja tai tuotteita.
Jättämällä arvostelun annat Suomalaiselle Kirjakaupalle oikeuden käyttää kyseisiä arvosteluja omassa markkinoinnissaan (sekä painettu että digitaalinen) ilman erillistä korvausta. Arvosteluja käytetään myös analysointiin ja markkinoinnin kehittämiseen.
Tuotearvostelun jättäneiden kesken arvotaan säännöllisin väliajoin tuotepalkintoja. Tutustu arvonnan sääntöihin täällä.
Mikäli haluat poistaa jättämäsi tuotearvostelun verkkokaupastamme, pyyntö tästä tulee ohjata asiakaspalveluumme: asiakaspalvelu@suomalainen.com.
Tuotearvostelut eivät ole tarkoitettu asiakasreklamaatioiden tai tilauskyselyjen tekemiseen. Reklamaatiotapauksissa pyydämme ottamaan yhteyttä asiakaspalveluumme: asiakaspalvelu@suomalainen.com.
Jättämällä arvostelun suomalainen.com -verkkokauppaan hyväksyt yllämainitut käytännöt ja ehdot.
Lue lisää tuotearvosteluista.