{"id":"https://openalex.org/W1979870634","doi":"https://doi.org/10.1145/1621995.1622035","title":"Lessons from trying to develop a robust documentation exemplar","display_name":"Lessons from trying to develop a robust documentation exemplar","publication_year":2009,"publication_date":"2009-10-05","ids":{"openalex":"https://openalex.org/W1979870634","doi":"https://doi.org/10.1145/1621995.1622035","mag":"1979870634"},"language":"en","primary_location":{"id":"doi:10.1145/1621995.1622035","is_oa":false,"landing_page_url":"https://doi.org/10.1145/1621995.1622035","pdf_url":null,"source":null,"license":null,"license_id":null,"version":"publishedVersion","is_accepted":true,"is_published":true,"raw_source_name":"Proceedings of the 27th ACM international conference on Design of communication","raw_type":"proceedings-article"},"type":"article","indexed_in":["crossref"],"open_access":{"is_oa":false,"oa_status":"closed","oa_url":null,"any_repository_has_fulltext":false},"authorships":[{"author_position":"first","author":{"id":"https://openalex.org/A5008401941","display_name":"Lynn Robert Carter","orcid":null},"institutions":[{"id":"https://openalex.org/I4210089979","display_name":"Carnegie Mellon University Qatar","ror":"https://ror.org/00az5dt38","country_code":"QA","type":"education","lineage":["https://openalex.org/I4210089979","https://openalex.org/I74973139"]}],"countries":["QA"],"is_corresponding":true,"raw_author_name":"Lynn Robert Carter","raw_affiliation_strings":["Carnegie Mellon University in Qatar, Doha, Qatar"],"affiliations":[{"raw_affiliation_string":"Carnegie Mellon University in Qatar, Doha, Qatar","institution_ids":["https://openalex.org/I4210089979"]}]},{"author_position":"last","author":{"id":"https://openalex.org/A5019717058","display_name":"Andreas Karatsolis","orcid":"https://orcid.org/0000-0003-4596-2038"},"institutions":[{"id":"https://openalex.org/I4210089979","display_name":"Carnegie Mellon University Qatar","ror":"https://ror.org/00az5dt38","country_code":"QA","type":"education","lineage":["https://openalex.org/I4210089979","https://openalex.org/I74973139"]}],"countries":["QA"],"is_corresponding":false,"raw_author_name":"Andreas Karatsolis","raw_affiliation_strings":["Carnegie Mellon University in Qatar, Doha, Qatar"],"affiliations":[{"raw_affiliation_string":"Carnegie Mellon University in Qatar, Doha, Qatar","institution_ids":["https://openalex.org/I4210089979"]}]}],"institutions":[],"countries_distinct_count":1,"institutions_distinct_count":2,"corresponding_author_ids":["https://openalex.org/A5008401941"],"corresponding_institution_ids":["https://openalex.org/I4210089979"],"apc_list":null,"apc_paid":null,"fwci":0.7403,"has_fulltext":false,"cited_by_count":11,"citation_normalized_percentile":{"value":0.81733182,"is_in_top_1_percent":false,"is_in_top_10_percent":false},"cited_by_percentile_year":{"min":89,"max":98},"biblio":{"volume":null,"issue":null,"first_page":"199","last_page":"204"},"is_retracted":false,"is_paratext":false,"is_xpac":false,"primary_topic":{"id":"https://openalex.org/T10260","display_name":"Software Engineering Research","score":0.9997000098228455,"subfield":{"id":"https://openalex.org/subfields/1710","display_name":"Information Systems"},"field":{"id":"https://openalex.org/fields/17","display_name":"Computer Science"},"domain":{"id":"https://openalex.org/domains/3","display_name":"Physical Sciences"}},"topics":[{"id":"https://openalex.org/T10260","display_name":"Software Engineering Research","score":0.9997000098228455,"subfield":{"id":"https://openalex.org/subfields/1710","display_name":"Information Systems"},"field":{"id":"https://openalex.org/fields/17","display_name":"Computer Science"},"domain":{"id":"https://openalex.org/domains/3","display_name":"Physical Sciences"}},{"id":"https://openalex.org/T10430","display_name":"Software Engineering Techniques and Practices","score":0.9983999729156494,"subfield":{"id":"https://openalex.org/subfields/1710","display_name":"Information Systems"},"field":{"id":"https://openalex.org/fields/17","display_name":"Computer Science"},"domain":{"id":"https://openalex.org/domains/3","display_name":"Physical Sciences"}},{"id":"https://openalex.org/T10639","display_name":"Advanced Software Engineering Methodologies","score":0.996999979019165,"subfield":{"id":"https://openalex.org/subfields/1702","display_name":"Artificial Intelligence"},"field":{"id":"https://openalex.org/fields/17","display_name":"Computer Science"},"domain":{"id":"https://openalex.org/domains/3","display_name":"Physical Sciences"}}],"keywords":[{"id":"https://openalex.org/keywords/documentation","display_name":"Documentation","score":0.9537407159805298},{"id":"https://openalex.org/keywords/computer-science","display_name":"Computer science","score":0.6211810111999512},{"id":"https://openalex.org/keywords/software-documentation","display_name":"Software documentation","score":0.5965421795845032},{"id":"https://openalex.org/keywords/focus","display_name":"Focus (optics)","score":0.5844281911849976},{"id":"https://openalex.org/keywords/process","display_name":"Process (computing)","score":0.5509893894195557},{"id":"https://openalex.org/keywords/software-engineering","display_name":"Software engineering","score":0.5188073515892029},{"id":"https://openalex.org/keywords/technical-documentation","display_name":"Technical documentation","score":0.5053566098213196},{"id":"https://openalex.org/keywords/software","display_name":"Software","score":0.4795103371143341},{"id":"https://openalex.org/keywords/internal-documentation","display_name":"Internal documentation","score":0.46059927344322205},{"id":"https://openalex.org/keywords/software-system","display_name":"Software system","score":0.3957493007183075},{"id":"https://openalex.org/keywords/software-development","display_name":"Software development","score":0.34342625737190247},{"id":"https://openalex.org/keywords/software-development-process","display_name":"Software development process","score":0.2980973422527313},{"id":"https://openalex.org/keywords/programming-language","display_name":"Programming language","score":0.16093158721923828},{"id":"https://openalex.org/keywords/software-construction","display_name":"Software construction","score":0.13441187143325806}],"concepts":[{"id":"https://openalex.org/C56666940","wikidata":"https://www.wikidata.org/wiki/Q788790","display_name":"Documentation","level":2,"score":0.9537407159805298},{"id":"https://openalex.org/C41008148","wikidata":"https://www.wikidata.org/wiki/Q21198","display_name":"Computer science","level":0,"score":0.6211810111999512},{"id":"https://openalex.org/C81587897","wikidata":"https://www.wikidata.org/wiki/Q181702","display_name":"Software documentation","level":5,"score":0.5965421795845032},{"id":"https://openalex.org/C192209626","wikidata":"https://www.wikidata.org/wiki/Q190909","display_name":"Focus (optics)","level":2,"score":0.5844281911849976},{"id":"https://openalex.org/C98045186","wikidata":"https://www.wikidata.org/wiki/Q205663","display_name":"Process (computing)","level":2,"score":0.5509893894195557},{"id":"https://openalex.org/C115903868","wikidata":"https://www.wikidata.org/wiki/Q80993","display_name":"Software engineering","level":1,"score":0.5188073515892029},{"id":"https://openalex.org/C25688753","wikidata":"https://www.wikidata.org/wiki/Q1413406","display_name":"Technical documentation","level":3,"score":0.5053566098213196},{"id":"https://openalex.org/C2777904410","wikidata":"https://www.wikidata.org/wiki/Q7397","display_name":"Software","level":2,"score":0.4795103371143341},{"id":"https://openalex.org/C140396857","wikidata":"https://www.wikidata.org/wiki/Q16934771","display_name":"Internal documentation","level":5,"score":0.46059927344322205},{"id":"https://openalex.org/C149091818","wikidata":"https://www.wikidata.org/wiki/Q2429814","display_name":"Software system","level":3,"score":0.3957493007183075},{"id":"https://openalex.org/C529173508","wikidata":"https://www.wikidata.org/wiki/Q638608","display_name":"Software development","level":3,"score":0.34342625737190247},{"id":"https://openalex.org/C180152950","wikidata":"https://www.wikidata.org/wiki/Q2904257","display_name":"Software development process","level":4,"score":0.2980973422527313},{"id":"https://openalex.org/C199360897","wikidata":"https://www.wikidata.org/wiki/Q9143","display_name":"Programming language","level":1,"score":0.16093158721923828},{"id":"https://openalex.org/C186846655","wikidata":"https://www.wikidata.org/wiki/Q3398377","display_name":"Software construction","level":4,"score":0.13441187143325806},{"id":"https://openalex.org/C120665830","wikidata":"https://www.wikidata.org/wiki/Q14620","display_name":"Optics","level":1,"score":0.0},{"id":"https://openalex.org/C121332964","wikidata":"https://www.wikidata.org/wiki/Q413","display_name":"Physics","level":0,"score":0.0}],"mesh":[],"locations_count":1,"locations":[{"id":"doi:10.1145/1621995.1622035","is_oa":false,"landing_page_url":"https://doi.org/10.1145/1621995.1622035","pdf_url":null,"source":null,"license":null,"license_id":null,"version":"publishedVersion","is_accepted":true,"is_published":true,"raw_source_name":"Proceedings of the 27th ACM international conference on Design of communication","raw_type":"proceedings-article"}],"best_oa_location":null,"sustainable_development_goals":[],"awards":[],"funders":[],"has_content":{"grobid_xml":false,"pdf":false},"content_urls":null,"referenced_works_count":13,"referenced_works":["https://openalex.org/W1516710803","https://openalex.org/W1522500515","https://openalex.org/W1559658511","https://openalex.org/W1596744619","https://openalex.org/W1986951532","https://openalex.org/W1991682572","https://openalex.org/W2018977354","https://openalex.org/W2073816521","https://openalex.org/W2114653055","https://openalex.org/W2125869117","https://openalex.org/W2166320445","https://openalex.org/W2568476927","https://openalex.org/W4299584468"],"related_works":["https://openalex.org/W1970455545","https://openalex.org/W31410542","https://openalex.org/W2108337646","https://openalex.org/W1990141983","https://openalex.org/W3172318907","https://openalex.org/W2955439455","https://openalex.org/W2033083755","https://openalex.org/W2062980587","https://openalex.org/W2465647915","https://openalex.org/W2128267129"],"abstract_inverted_index":{"Software":[0],"system":[1,103],"documentation":[2,29,55,69,104],"has":[3,31],"been":[4,32,62],"an":[5],"integral":[6],"part":[7],"of":[8,27,37,43,111],"the":[9,13,25,35,41,67,90,94,100],"development":[10],"process":[11],"since":[12],"first":[14],"efforts":[15],"to":[16,34,51,89],"design":[17],"and":[18,21,45,113],"implement":[19],"large":[20,112],"robust":[22,54],"systems.":[23,115],"However,":[24],"focus":[26],"this":[28],"typically":[30],"limited":[33],"production":[36],"discrete":[38],"artifacts,":[39],"despite":[40],"richness":[42],"data":[44],"genres":[46],"that":[47],"surround":[48],"it.":[49],"Efforts":[50],"develop":[52],"a":[53],"exemplar":[56],"-":[57,59],"Della":[58,95],"have":[60],"not":[61],"completely":[63],"successful,":[64],"mainly":[65],"because":[66],"provided":[68],"was":[70],"largely":[71],"ignored":[72],"by":[73],"many":[74],"students":[75],"for":[76],"simpler":[77],"but":[78],"less":[79],"effective":[80],"alternate":[81],"designs.":[82],"This":[83],"paper":[84],"will":[85],"present,":[86],"in":[87,109],"addition":[88],"lessons":[91],"learned":[92],"from":[93],"project,":[96],"some":[97],"insights":[98],"into":[99],"direction":[101],"software":[102],"now":[105],"should":[106],"be":[107],"taking":[108],"support":[110],"long-lived":[114]},"counts_by_year":[{"year":2023,"cited_by_count":1},{"year":2021,"cited_by_count":1},{"year":2019,"cited_by_count":1},{"year":2018,"cited_by_count":4},{"year":2017,"cited_by_count":1},{"year":2016,"cited_by_count":1},{"year":2015,"cited_by_count":1}],"updated_date":"2025-11-06T03:46:38.306776","created_date":"2025-10-10T00:00:00"}