Ashley R. Hardin
ABSTRACT
The Red Hat OpenShift documentation repository is situated in a unique open source environment in which anybody with a GitHub account can contribute directly to the documentation set. One of the primary contributors to the documentation repository are developers, which presents a challenge. The technical writers on the Red Hat OpenShift documentation team who collaboratively write, edit, and merge these contributions are faced with the challenge of maintaining user-centered rather than engineering- centered documentation. Furthermore, the technical writers lack direct interaction with external customers. Considering these challenges, this industry insight report discusses several methods that can be employed to maintain a customer-centric focus and improve the documentation set: focus on user stories, network with internal customers and stakeholders who work closest with external customers, and seek opportunities to work on customer cases.
- Joseph Jeyaraj. 2004. Liminality and othering the issue of rhetorical authority in technical discourse. Journal of Business and Technical Communication 18 (01 2004), 9--38. Google Scholar
Cross Ref
- Scott L. Jones. 2005. From writers to information coordinators: Technology and the changing face of collaboration. In W. Bishop, and H. Hstrom (Eds.), Genre and writing: Issues, arguments, alternatives (pp. 56--66). Postmouth, NH: Boynton / Cook Publishers Heinemann. 449--467.Google Scholar
- Martha F. Lee and Brad Mehlenbacher. 2000. Technical writer/subject-matter expert interaction: The writers perspective, the organizational challenge. Technical Communication 47, 4 (2000).Google Scholar
- Tammy Rice-Bailey. 2016. The role and value of technical communicators: Technical communicators and subject matter experts weigh in. Technical Communication Quarterly 25, 4 (2016), 230--243. Google ScholarCross Ref
- Warren Sack, Francoise Detienne, Nicolas Ducheneaut, Jean-Marie Burkhardt, Dilan Mahendran, and Flore Barcellini. 2006. A methodological framework for socio-cognitive analyses of collaborative design of open source software. Computer Supported Cooperative Work 15 (07 2006), 229--250. Google ScholarDigital Library
- Shaun Slattery. 2007. Undistributing work through writing: How technical writers manage texts in complex information environments. Technical Communication Quarterly 16, 3 (2007), 311--325. Google ScholarCross Ref
Index Terms
- Building bridges to customer needs in open source documentation
Recommendations
Open-source documentation: in search of user-driven, just-in-time writing
SIGDOC '01: Proceedings of the 19th annual international conference on Computer documentationIterative development models allow developers to respond quickly to changing user requirements, but place increasing demands on writers who must handle increasing amounts of change with ever-decreasing resources. In the software development world, one ...
Building bridges: customisation and mutual intelligibility in shared category management
GROUP '99: Proceedings of the 1999 ACM International Conference on Supporting Group WorkResearch into collaborative document use often concentrates on how people share document content. However, studies of real-world document practices reveal that the structures by which document corpora are organised may also, themselves, be important ...
Open source software licenses: Strong-copyleft, non-copyleft, or somewhere in between?
Studies on open source software (OSS) have shown that the license under which an OSS is released has an impact on the success or failure of the software. In this paper, we model the relationship between an OSS developer's utility, the effort that goes ...
Comments