Scribble: Closing the book on Ad Hoc documentation tools

Matthew Flatt*, Eli Barzilay, Robert Bruce Findler

*Corresponding author for this work

Research output: Chapter in Book/Report/Conference proceedingConference contribution

13 Scopus citations

Abstract

Scribble is a system for writing library documentation, user guides, and tutorials. It builds on PLT Scheme's technology for language extension, and at its heart is a new approach to connecting prose references with library bindings. Besides the base system, we have built Scribble libraries for JavaDoc-style API documentation, literate programming, and conference papers. We have used Scribble to produce thousands of pages of documentation for PLT Scheme; the new documentation is more complete, more accessible, and better organized, thanks in large part to Scribble's flexibility and the ease with which we cross-reference information across levels. This paper reports on the use of Scribble and on its design as both an extension and an extensible part of PLT Scheme.

Original languageEnglish (US)
Title of host publicationICFP'09 - Proceedings of the 2009 ACM SIGPLAN International Conference on Functional Programming
Pages109-120
Number of pages12
DOIs
StatePublished - Nov 27 2009
Event2009 ACM SIGPLAN International Conference on Functional Programming, ICFP'09 - Edinburgh, United Kingdom
Duration: Aug 31 2009Sep 2 2009

Publication series

NameProceedings of the ACM SIGPLAN International Conference on Functional Programming, ICFP

Other

Other2009 ACM SIGPLAN International Conference on Functional Programming, ICFP'09
CountryUnited Kingdom
CityEdinburgh
Period8/31/099/2/09

Keywords

  • Design
  • Documentation
  • Languages

ASJC Scopus subject areas

  • Software

Fingerprint Dive into the research topics of 'Scribble: Closing the book on Ad Hoc documentation tools'. Together they form a unique fingerprint.

Cite this