--- title: "Creating documentation in a Continuous Integration/Continuous Delivery environment" id: "11730" type: "post" slug: "creating-documentation-in-a-continuous-integrationcontinuous-deployment-environment" published_at: "2016-04-22T07:47:48+00:00" modified_at: "2016-04-22T07:47:48+00:00" url: "https://www.cherryleaf.com/2016/04/creating-documentation-in-a-continuous-integrationcontinuous-deployment-environment/" markdown_url: "https://www.cherryleaf.com/2016/04/creating-documentation-in-a-continuous-integrationcontinuous-deployment-environment.md" excerpt: "Creating user documentation and online Help in a Continuous Integration/Continuous Delivery environment can be challenging for technical communicators and developers." taxonomy_category: - "Agile" - "Technical Author" - "Technical Authors" - "Technical Documentation" - "tools" taxonomy_post_tag: - "Agile" - "Continuous Delivery" - "Continuous Integration" - "software" - "Technical Communication" - "tools" --- Creating user documentation and online Help in a Continuous Integration/Continuous Delivery environment can be challenging for technical communicators and developers. Below are Wikipedia’s definitions of these two practices: - Continuous Integration (CI) is the software engineering practice of frequently integrating all new or changed developer code to a shared repository several times a day. - Continuous Delivery (CD) is a software engineering approach in which teams produce software in short cycles, ensuring that the software can be reliably released at any time. It aims at building, testing, and releasing software faster and more frequently. This means potentially there could be new software releases each day, and there could be a need for to update screenshots and Help content to reflect these changes. Alex Soto of Cloudbees has posted a video of how he has automated his documentation updates, using Jenkins (a continuous integration tool), Asciidoctor (a text processor and publishing tool) and Gradle (a build automation system, similar to the Apache Ant and Apache Maven tools used in DITA publishing): Continuous Documentation with Jenkins Gradle Asciidoctor Automated builds and (command line) publishing was one of the popular themes at last week’s MadWorld 2016 conference. Andrei Essaoulov showed how kCura was also using Jenkins builds (and PowerShell scripts) with MadCap Flare to publish automatically. . We’re likely to see more Technical Authors automating documentation publishing and integrating it with the development teams processes, and it promises to enable software developers to deliver up-to-date content efficiently and quickly. Have you worked in this way? You can share your thoughts below. ### Share this: - [Share on Facebook (Opens in new window) Facebook](https://www.cherryleaf.com/2016/04/creating-documentation-in-a-continuous-integrationcontinuous-deployment-environment/?share=facebook) - [Share on LinkedIn (Opens in new window) LinkedIn](https://www.cherryleaf.com/2016/04/creating-documentation-in-a-continuous-integrationcontinuous-deployment-environment/?share=linkedin) - [Share on WhatsApp (Opens in new window) WhatsApp](https://www.cherryleaf.com/2016/04/creating-documentation-in-a-continuous-integrationcontinuous-deployment-environment/?share=jetpack-whatsapp) - [Share on Bluesky (Opens in new window) Bluesky](https://www.cherryleaf.com/2016/04/creating-documentation-in-a-continuous-integrationcontinuous-deployment-environment/?share=bluesky) - ### *Related* ### Leave a Reply[Cancel reply](/2016/04/creating-documentation-in-a-continuous-integrationcontinuous-deployment-environment/#respond) This site uses Akismet to reduce spam. [Learn how your comment data is processed.](https://akismet.com/privacy/) #### Previous post [API documentation design patterns](https://www.cherryleaf.com/2016/02/api-documentation-design-patterns/) #### Next post [Our approach to writing procedures documentation](https://www.cherryleaf.com/2016/04/our-approach-to-writing-procedures-documentation/) #### Browse posts by month Browse posts by month Select Month June 2026 (12) May 2026 (8) April 2026 (6) March 2026 (14) February 2026 (9) January 2026 (9) December 2025 (7) November 2025 (9) October 2025 (10) September 2025 (7) August 2025 (6) July 2025 (1) June 2025 (3) May 2025 (2) April 2025 (5) March 2025 (3) February 2025 (3) January 2025 (2) November 2024 (8) October 2024 (3) September 2024 (2) August 2024 (3) July 2024 (4) June 2024 (1) May 2024 (2) April 2024 (4) March 2024 (1) February 2024 (2) January 2024 (1) December 2023 (2) November 2023 (9) October 2023 (8) September 2023 (5) August 2023 (3) July 2023 (1) June 2023 (1) May 2023 (2) April 2023 (3) March 2023 (2) January 2023 (2) December 2022 (4) November 2022 (1) October 2022 (1) September 2022 (1) August 2022 (1) July 2022 (1) June 2022 (1) May 2022 (2) April 2022 (1) March 2022 (1) February 2022 (1) January 2022 (2) December 2021 (1) November 2021 (2) October 2021 (1) August 2021 (1) July 2021 (2) June 2021 (3) May 2021 (5) April 2021 (3) March 2021 (3) February 2021 (1) January 2021 (2) December 2020 (4) November 2020 (4) August 2020 (3) February 2020 (3) January 2020 (1) November 2019 (3) October 2019 (1) September 2019 (1) August 2019 (3) July 2019 (2) June 2019 (3) May 2019 (4) April 2019 (1) November 2018 (2) October 2018 (1) July 2018 (2) June 2018 (4) May 2018 (2) April 2018 (3) March 2018 (4) February 2018 (2) January 2018 (3) December 2017 (2) October 2017 (3) September 2017 (1) August 2017 (3) July 2017 (2) June 2017 (7) May 2017 (4) April 2017 (5) March 2017 (1) February 2017 (7) January 2017 (1) December 2016 (3) November 2016 (4) October 2016 (1) September 2016 (5) July 2016 (1) June 2016 (3) May 2016 (1) April 2016 (2) February 2016 (2) January 2016 (5) December 2015 (1) November 2015 (4) October 2015 (2) August 2015 (1) July 2015 (1) June 2015 (2) May 2015 (3) February 2015 (2) January 2015 (6) December 2014 (1) October 2014 (1) September 2014 (4) June 2014 (4) May 2014 (1) April 2014 (2) March 2014 (3) February 2014 (4) January 2014 (4) November 2013 (2) October 2013 (5) September 2013 (3) July 2013 (3) June 2013 (11) May 2013 (4) April 2013 (6) March 2013 (7) February 2013 (4) January 2013 (4) December 2012 (9) November 2012 (23) October 2012 (14) September 2012 (8) August 2012 (4) July 2012 (12) June 2012 (12) May 2012 (10) April 2012 (8) March 2012 (12) February 2012 (3) January 2012 (6) December 2011 (2) October 2011 (3) August 2011 (1) June 2011 (5) May 2011 (2) April 2011 (1) January 2011 (1) December 2010 (1) November 2010 (3) October 2010 (4) September 2010 (8) August 2010 (5) May 2010 (2) April 2010 (3) March 2010 (3) February 2010 (2) January 2010 (3) December 2009 (2) November 2009 (6) September 2009 (1) July 2009 (6) June 2009 (7) April 2009 (8) March 2009 (3) February 2009 (3) January 2009 (3) December 2008 (1) November 2008 (3) October 2008 (3) September 2008 (4) August 2008 (1) July 2008 (3) June 2008 (5) May 2008 (2) April 2008 (2) March 2008 (3) February 2008 (2) January 2008 (1) November 2007 (3) October 2007 (2) September 2007 (1) July 2007 (3) November 2006 (1) October 2006 (2) September 2006 (3) August 2006 (1) April 2006 (1) March 2006 (3) #### Browse posts by category