Change search
CiteExportLink to record
Permanent link

Direct link
Cite
Citation style
  • apa
  • ieee
  • modern-language-association-8th-edition
  • vancouver
  • Other style
More styles
Language
  • de-DE
  • en-GB
  • en-US
  • fi-FI
  • nn-NO
  • nn-NB
  • sv-SE
  • Other locale
More languages
Output format
  • html
  • text
  • asciidoc
  • rtf
Att Skapa Bra Utåtriktad Dokumentation: Stöd för utveckling av dokumentationspolicy
Blekinge Institute of Technology, Faculty of Computing, Department of Software Engineering.
2022 (Swedish)Independent thesis Basic level (university diploma), 10 credits / 15 HE creditsStudent thesis
Abstract [sv]

Extern dokumentation finns till för att förklara för en slutanvändare hur ett verktyg fungerar och hur det bör användas. Att skriva dokumentation tar dock tid vilket kan leda till att vissa utvecklare väljer att avstå från detta. Dokumentationen kan sedan bli eftersatt eller sakna relevant information vilket kan leda till att vissa väljer att inte läsa den. För att ta reda på vad utvecklare önskar av dokumentation och hur man kan stötta dem vid skapandet av det skapades en enkät. Två intervjuer utfördes även som stöd för att komma på frågor samt alternativ till enkäten och delvis svara på frågeställningarna. En litteraturundersökning utfördes av samma anledning. Enkäten delades ut till de med en i undersökningens stund anställning som utvecklare och delades även på internet.

22 deltagare svarade på enkäten och efter en analys av det totala resultatet drogs följande slutsatser: De viktigaste egenskaperna som dokumentation bör besitta anses vara att den ska vara aktuell och utförlig. Den viktigaste typen av innehåll anses bland annat vara kodexempel på vanliga användningsområden. Förslag på stöd eller hjälp för skaparna av dokumentation är att de bör se det som en iterativ process. När dokumentation ska publiceras ansågs en README-fil på Github vara lämpligast. Om något komplext dokumenteras kan en separat hemsida vara mer lämplig.

Place, publisher, year, edition, pages
2022. , p. 49
Keywords [sv]
Extern dokumentation, dokumentationspolicy, kodexempel
National Category
Software Engineering
Identifiers
URN: urn:nbn:se:bth-23249OAI: oai:DiVA.org:bth-23249DiVA, id: diva2:1673327
Subject / course
PA1438 Självständigt arbete Webbprogrammering
Educational program
PAGWG Webbprogrammering
Supervisors
Examiners
Available from: 2022-06-21 Created: 2022-06-20 Last updated: 2022-06-21Bibliographically approved

Open Access in DiVA

fulltext(1670 kB)69 downloads
File information
File name FULLTEXT01.pdfFile size 1670 kBChecksum SHA-512
b32b37d2ad017a6b20cb521b38585153303ad11c5bd9f7c19874eba9358c910559f6344f2e93e0b2dd9e1f3c595979c1efea2c08b44622022fb4047a590a8cbf
Type fulltextMimetype application/pdf

By organisation
Department of Software Engineering
Software Engineering

Search outside of DiVA

GoogleGoogle Scholar
Total: 70 downloads
The number of downloads is the sum of all downloads of full texts. It may include eg previous versions that are now no longer available

urn-nbn

Altmetric score

urn-nbn
Total: 115 hits
CiteExportLink to record
Permanent link

Direct link
Cite
Citation style
  • apa
  • ieee
  • modern-language-association-8th-edition
  • vancouver
  • Other style
More styles
Language
  • de-DE
  • en-GB
  • en-US
  • fi-FI
  • nn-NO
  • nn-NB
  • sv-SE
  • Other locale
More languages
Output format
  • html
  • text
  • asciidoc
  • rtf