Simplifying the Scientific Writing and Review Process with SciFlow
Abstract
:1. Introduction
2. The Particularities of Scientific Writing
2.1. Roles and Phases of Scientific Writing
2.2. Classic Word Processors and Tools for Scientific Writing
for writing, especially within the technical field [11].
is a typesetting system and markup language designed to publish technical and scientific documentation. It is available as free software and is supported by various writing environments. These may be preferred by some people, since
itself does not provide What You See Is What You Get (WYSIWYG) functionality, as Microsoft Word or Open Office do. Rather than providing a fully laid out document, a
document consists of text, commands and document markup. This causes for a separation of content and layout and has also be described as What You See Is What You Want, acknowledging that the edited document is only a representation of the document contents. It is not an exact replica of the final layout [12].
allows for the creation of DVI, PS or PDF [13] files that fulfill the requirements of scientific and technical documents (e.g. table of contents, figures, mathematical equations). Additionally, the integration of BiBTeX files allows a writer of
documents to maintain and style a bibliography individually [14] .2.3. Results of a Survey on Scientific Writing
by 18.3% (246 people), Open Office was used by 11.1% (149 people) and other tools were used by 3.6% (48 people, N = 1,345). Out of these participants, 39.5% (468 people) answered the survey after having written a thesis and 54,5% (646 people) related the survey to having written a homework assignment. The remainder had written a scientific paper (4.3%/51 people), a dissertation (1.8%/21 people) or other scientific documents (71 people, N = 1,258). In the following we only present the specific results for Microsoft Word and
, reflecting their high percentages of use. For neither of them we regard different versions of the software. Most of the questions participants were presented a six-point Likert scale ranging from 1 to 6.
for the easier setup but lost on all other parts of this section. The participants found
to be 23% easier to use for citations and referencing, 31% better for the creation of the table of contents, page numbers and general formatting and 25% better for the creation of a printable document.
shows a marginal 0.02 and 0.14 point lead for Word on merging other’s work and revising. As for the document layout,
achieves 19% (0.94 points) better results on average and gains 5% (0.21 points) on sharing the document.
, the participants stated that it generates professional layouts, lets the user focus on writing in stead of the layout, and that the table of content generation works well. Generating professional layouts here means that it was easy to create a document that followed the given restrictions for scientific writing. The negative statements for
were lead by the fact that participants perceived it as being difficult to position tables and figures. In addition they did not like the lack of WYSIWYG features in the particular
editor they used and that sharing the document for review was hard.2.4. Requirements for a Scientific Word Processor
2.5. Limitations of Existing Concepts
as well as collaborative concepts to compose scientific documents. Even though all of these tools make scientific writing possible, they also have limitations. Our survey revealed that mostly Microsoft Word,
and Google Docs were used for scientific writing. After having introduced their advantages in the previous sections, we will now name major limitations in respect to scientific writing for each of these tools.
shares the limitation of review with Word. While it is possible to send PDF or even plain
documents out for review, a manual merging process has to be employed, to reduce the various review versions to one document once review is completed. Secondly,
is perceived to have a steep learning curve [22], which may prevent users from choosing it for writing. This may be true especially those writers, who do not come from a technical field. In this respect [23] notes that, while
gives the author freedom to set a document in the way he likes, it also demands for the author to have an idea about the nature of typographical composing.
with external tools and plugins in a way that most limitations become void, but a user who is new to these tools will have to discover them during a long lasting process and install a working solution by hand. In the following section we introduce a novel software approach to scientific writing which is derived from the results of our survey and the limitations of existing software. Moreover, it was designed to let writers focus on writing itself, not on dealing with a word processor to set everything up.3. The SciFlow Approach to Scientific Writing
3.1. Granularity of the Problem
3.2. Four Guiding Principles
3.2.1. Scalability
- When the work load a web service experiences, depends on the number of people who use the system, it has to be possible to instantiate this service an arbitrary number of times without manual intervention. An example for such a service would be the document publishing service, which creates PDF files from a document and a given document template. In this case, the demand for the service will rise with the number of authors, thus more instances will have to be made available.
- To manage an arbitrary number of services, communication between components, e.g., the client and the services, has to be robust. This calls for an asynchronous communication structure, so messages may be delivered when a service is available and held back when it is unresponsive. Such a communication structure will also allow to handle multiple instances of a service: Addressing a message to an arbitrary service allows for service instances with free capacities to accept the message, instead of letting the message sender choose the instance. If no such service is available, the message will wait until the situation changes or more instances of the particular service are launched. This calls for monitoring as we shall now explain.
- To ensure scalability, the number of services within the SciFlow system has to reflect the number of requests, made to a particular service. For the asynchronous communication structure this means that the number of messages requesting a specific service has to be monitored. Since (1) all services can be launched an arbitrary number of times and (2) the asynchronous communication structure allows for launching and stopping of services without interrupting ongoing operations, a high number of messages may be dealt with by launching an appropriate amount of new services.

3.2.2. Simplicity and Transparency



3.2.3. Safety and Recoverability

3.2.4. Ease of Revision
and then into a PDF using dblatex. The important thing to note is that the unique identifier is carried through all of theses forms. In the
source file a abbreviated form of the identifier is assigned to each document element in form of a label. We call this a quick access code.
4. Application Scenarios for SciFlow
4.1. Writing a Thesis
style file they have already been using. This style file sets up the document margins as well as the citation style and the layout of the bibliography and will later determine the layout of the final thesis. Now she sends the link to the SciFlow writing client to her student Alice along with a username and an automatically assigned password. Alice opens the link and is guided through the installation process. Through this website Adobe AIR and the SciFlow client are installed within a minute. Once she has done so, she may log in with her credentials and start writing. Alice begins with typing some text and uses the styles drawer of the SciFlow client (see Figure 1) to create her chapter structure and a first draft. Once she has done so, Alice decides to consult Carol to be sure that the structure is set up right. She clicks sharing and enters Carol’s email address. Carol now receives an email with the link to a review website. Since Carol is currently traveling back from a conference, she opens the link on her mobile phone and begins reading. When she sees something noteworthy, she uses the review website’s comment function.4.2. Scientific Workshops
5. Conclusions and Outlook
5.1. Discussion of the Presented Approach
5.2. Future Research and Development Opportunities
References
- Baecker, R.M.; Nastos, D.; Posner, I.R.; Mawby, K.L. The User-centred Iterative Design of Collaborative Writing Software. In Proceedings of the INTERACT ’93 and CHI ’93 Conference on Human Factors in Computing Systems, Amsterdam, The Netherlands, 24–29 April 1993; ACM: New York, NY, USA, 1993; pp. 399–405. [Google Scholar]
- Noel, S.; Robert, J.M. Empirical Study on Collaborative Writing: What Do Co-authors Do, Use, and Like? Comput. Support. Cooperat. Work 2006, 13, 63–89. [Google Scholar] [CrossRef]
- Grover, C. Word 2007: The Missing Manual; O’Reilly Media: Sebastopol, CA, USA, 2006. [Google Scholar]
- Liu, J.; Sadler, R.W. The effect and affect of peer review in electronic versus traditional modes on L2 writing. J. Engl. Acad. Purposes 2003, 2, 193–227. [Google Scholar] [CrossRef]
- Academic Software Zurich. Citavi Reference Management Software. Available online: http://www.citavi.com/ (accessed on 2 December 2010).
- Center for History and New Media, George Mason University. Zotero. Available online: http://www.zotero.org/ (accessed on 2 December 2010).
- Google. Google Scholar. Available online: http://scholar.google.com (accessed on 2 December 2010).
- Ritterbush, J. Supporting Library Research with LibX and Zotero. J. Web Librarianship 2007, 1, 111–122. [Google Scholar] [CrossRef]
- Oracle. Open Office. Available online: http://www.openoffice.org/ (accessed on 2 December 2010).
- Rossi, B.; Russo, B.; Zuliani, P.; Succi, G. On the Transition to an Open Source Solution for Desktop Office Automation. Lect. Note. Comp. Sci. 2005, 316, 277–285. [Google Scholar]
- Lamport, L. LaTeX: A Document Preparation System; Addison-Wesley Professional: Reading, MA, USA.
- van der Hoeven, J. GNU TeXmacs. SIGSAM Bull. 2004, 38, 24–25. [Google Scholar] [CrossRef]
- UIUC REU Number Theory Program. Introduction to LaTeX. Available online: http://www.math.uiuc.edu/hildebr/tex/course/intro1.html (accessed on 2 December 2010).
- Patashnik, O. Designing BibTeX Styles. 1988. Available online: http://www.eeng.dcu.ie/local-docs/btxdocs/btxhak/btxhak/btxhak.html (accessed on 2 December 2010).
- Google. Create and share your work online with Google Docs. Available online: http://docs.google.com (accessed on 2 December 2010).
- Dekeyser, S.; Watson, R. Extending Google Docs to Collaborate on Research Papers. Available online: http://www.sci.usq.edu.au/staff/dekeyser/googledocs.pdf (accessed on 2 December 2010).
- Sterken, C. Advice on Writing a Scientific Paper. In Astrophysics of Variable Stars; Astronomical Society of the Pacific: San Francisco, CA, USA, 2006. [Google Scholar]
- Adobe. Adobe Buzzword. Available online: http://www.adobe.com/acom/buzzword (accessed on 2 December 2010).
- Gopen, G.; Swan, J. The Science of Scientific Writing. Available online: https://www.americanscientist.org/issues/id.877,y.0,no.,content.true,page.1,css.print/issue.aspx (accessed on 2 December 2010).
- Skern, T. Writing Scientific English: A Workbook; UTB: Stuttgart, Germany, 2009. [Google Scholar]
- Aragon, T.J. Practical LATEX for Public Health and Medicine. Available online: http://www.medpi.net/aragon/ (accessed on 2 December 2010).
- Feruglio, G.V. Do Journals Honor LATEX Submissions? Available online: http://www.tug.org/TUGboat/Articles/tb17-2/tb51vali.pdf (accessed on 2 December 2010).
- Hwang, A.D. Writing in the Age of LATEX. Notices AMS 1995, 42, 878–882. Available online: http://www-ljk.imag.fr/membres/Bernard.Ycart/writing/hwang.pdf (accessed on 2 December 2010). [Google Scholar]
- Eichler, F. Simplifying The Scientific Writing And Review Process. Master’s Thesis, University of Paderborn, Paderborn, Germany, 2010. [Google Scholar]
- Onibokun, A.; Palankar, M. Amazon S3: Black-Box Performance Evaluation. Available online: http://www.csee.usf.edu/aoniboku/Docs/AmazonS3 ProjectReport(2).pdf (accessed on 2 December 2010).
- Amazon. Auto-scaling Amazon EC2 with Amazon SQS. Available online: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=1464&categoryID=177 (accessed on 2 December 2010).
- Brinkmann, A.; Effert, S. Snapshots and Continuous Data Replication in Cluster Storage Environments. In Proceedings of Fourth International Workshop on Storage Network Architecture and Parallel I/Os (SNAPI 2007), San Diego, CA, USA, 24 September 2007.
- Journal Publishing Tag Set Tag Library version 3.0. Available online: http://dtd.nlm.nih.gov/publishing/tag-library/ (accessed on 2 December 2010).
- Amazon. Amazon S3 Service Level Agreement. Available online: http://aws.amazon.com/s3-sla/ (accessed on 2 December 2010).
- MobileRead. MOBI. Available online: http://wiki.mobileread.com/wiki/MOBI (accessed on 2 December 2010).
- Amazon. Amazon Kindle. Available online: http://www.amazon.com/dp/B0015T963C (accessed on 2 December 2010).
- Adobe. Adobe Acrobat Family: Product Comparison. Available online: http://www.adobe.com/products/acrobat/matrix.html (accessed on 2 December 2010).
© 2010 by the authors. Licensee MDPI, Basel, Switzerland. This article is an open access article distributed under the terms and conditions of the Creative Commons Attribution license ( http://creativecommons.org/licenses/by/3.0/).
Share and Cite
Eichler, F.; Reinhardt, W. Simplifying the Scientific Writing and Review Process with SciFlow. Future Internet 2010, 2, 645-661. https://doi.org/10.3390/fi2040645
Eichler F, Reinhardt W. Simplifying the Scientific Writing and Review Process with SciFlow. Future Internet. 2010; 2(4):645-661. https://doi.org/10.3390/fi2040645
Chicago/Turabian StyleEichler, Frederik, and Wolfgang Reinhardt. 2010. "Simplifying the Scientific Writing and Review Process with SciFlow" Future Internet 2, no. 4: 645-661. https://doi.org/10.3390/fi2040645
APA StyleEichler, F., & Reinhardt, W. (2010). Simplifying the Scientific Writing and Review Process with SciFlow. Future Internet, 2(4), 645-661. https://doi.org/10.3390/fi2040645
