DITA

Gilbane Advisor 5-19-17 — e-commerce, meta-platform, summarization and ML, design

E-commerce: What China reveals about the future of shopping China’s e-commerce market is the world’s largest and fastest growing. It is also more mobile and more integrated with relevant platforms than those in the West, allowing for smoother customer experiences. This goes beyond WeChat e-commerce capability, the envy of western messaging platforms. There are reasons […]

This post originally published on https://gilbane.com

Categories: DITA

[May 31] DITA Summit: Best Practices and Lessons Learned From The Trenches

The Content Wrangler - Tue, 2017-05-09 19:56

4 DITA Webinars: Wednesday, May 31, 2017

Featuring Amber Swope, Jenifer Schlotfeldt, Rob Hanna, Keith Schengili-Roberts, Mark Lewis, Joe Gelb, Yehudit Lindblom

The Mini Virtual Summit on DITA Best Practices and Lessons Learned from the Trenches is a free, online educational event that provides strategies, tips, and lessons learned from technical communication practitioners.

The Summit (brought to you by Precision Content) features four presentations on issues impacting organizations that have adopted—or are planning to adopt—the Darwin Information Typing Architecture.

8:00am PT/ 11:00am ET

  • DITA Satisfaction Survey: Overcoming the BIG Challenges When Adopting DITA — Rob Hanna (Precision Content), Mark Lewis (Quark), and Keith Schengili-Roberts(IXIASOFT)—three content strategy experts with deep experience solving content conundrums with DITA, discuss the results of our 2017 DITA Satisfaction Survey. Our panel will review the top reasons survey respondents are dissatisfied with their DITA implementations. We’ll also discuss why some DITA projects fail and provide advice on how to best overcome these challenges (or avoid them altogether).

10:00am PT/ 1:00pm ET

  • DITA Best Practices: 10 Things You Can Do To Help Ensure Success — content strategy maven, Jennifer Schlotfeldt (IBM), highlights best practices to help ensure DITA project success. Jenifer will discuss ways to ensure the creation of effective topics, and how to properly architect content and assemble topics into information that is retrievable, organized, and reusable. She’ll also provide several “in the trenches” solutions for ensuring quality implementations, including guidance on content conversion.

Noon PT/ 3:00pm ET

  • Going DITA: Building an Implementation Plan for Positive Disruption — Joe Gelb (Zoomin Software) and Yehudit Lindblom (Suite Solutions) review a migration process that covers all the bases, helping you build your game plan for a winning DITA implementation.

2:00pm PT/ 5:00pm ET

  • It Takes A Village To Create Your Content Collection — Amber Swope (DITA Strategies) demystifies content collections and  helps attendees identify the requirements for a content collection, determine collection scope, and collaborate with stakeholders to build and maintain the collection.

Register today! It’s free.

Not sure you can attend? Register anyway. Attendees receive a link to the recording shortly after the event is over.

I hope to see you there, virtually speaking.

Scott Abel, The Content Wrangler

The post [May 31] DITA Summit: Best Practices and Lessons Learned From The Trenches appeared first on The Content Wrangler.

Categories: DITA

Gilbane Advisor 5-3-17 — SaaS era, Watson vs Einstein, e-commerce AI, FB monopoly

Why the SaaS era of journalism will be our most exciting yet During the first quarter century of the commercial internet, digital journalism has already gone through three eras: the portal years, the search years, and the social years. Each era advanced storytelling and presented new revenue streams, but I would argue that digital journalism […]

This post originally published on https://gilbane.com

Categories: DITA

Uniting API documentation and code: InfoQ article

JustWriteClick - Wed, 2017-05-03 18:18

At the beginning of this year, I worked hard to summarize my thoughts on API documentation, continuous publishing, and technical accuracy for developer documentation. The result is an article on InfoQ.com, edited by Deepak Nadig, who also was forward-thinking in having me speak to a few teams at Intuit about API documentation coupled with code.

Always Be Publishing: Continuous Integration & Collaboration in Code Repositories for REST API Docs

Here are the key takeaways from the article.

Key Takeaways

  • API documentation provides a critical path for predicting customer success.
  • Collaborating on documentation close to the code provides better reviews of both the code and the document files, more automation efficiencies, and enables quality tests for documentation specifically.
  • Provide common documentation frameworks, standards, automation, and tools to give teams an efficiency boost.

If you have a story to tell about CI/CD for API docs, please send a Pull Request on GitHub to tell your story on http://docslikecode.com.

Categories: DITA

Gilbane Digital Content Conference 2017 – Call for Speakers

Content management, marketing, and digital experience How to submit a speaking proposal Review the conference and track descriptions below. Read the Speaker Guidelines. If you have questions not answered in the guidelines email us at speaking@gilbane.com. Don’t worry too much about which track you suggest for your proposal, unless it is for a post-conference workshop. And… Submit your speaking […]

This post originally published on https://gilbane.com

Categories: DITA

The Wikidata data model and your SPARQL queries

bobdc.blog - Sun, 2017-04-23 13:43
Reference works to get you taking advantage of the fancy parts quickly. Bob DuCharme http://www.snee.com/bobdc.blog
Categories: DITA

How Balsamiq Solved Static Site Challenges with Code

JustWriteClick - Fri, 2017-04-21 11:58

Leon Barnard from Balsamiq wrote up a great series of challenges and solutions for the docslikecode.com website. His lessons learned are super helpful for all of us:

He summarizes the series best in his own words:

Static sites may seem to have more limitations than traditional CMSs or powerful technical writing tools. But if you can find a way around the limitations, you can reap the benefits that made static sites attractive in the first place. Markdown is easy. GitHub offers collaborative coding. A scripted robot can run a build command from a terminal. It’s writing excellent documentation that is tough. Fortunately, that’s what technical writers are good at. Having a developer liaison for the docs team can free writers from having to think about the limitations of the technology they’re using so they can focus on writing the docs.

Categories: DITA

Gilbane Advisor 4-18-17 — chatbots, nextgen IT, AR, marketing data, CX and distribution

What to do about the chatbot crisis It’s never been clear that messaging apps had a future as platforms. It is also a stretch to think of voice as a platform, at least in any general purpose sense. In either case it seems like a misuse of ‘platform’. Messaging and chat systems will continue to […]

This post originally published on https://gilbane.com

Categories: DITA

RSI merges with Orbis Technologies, Inc.

Really Strategies - Tue, 2017-04-11 19:00
rsi-2016.gif

 Orbis Technologies, Inc. and RSI Content Solutions Merge to Form a Global Content  Management Software and Solutions Company

Categories: DITA

How Symantec Embedded a Tech Writer on a Developer Team

JustWriteClick - Thu, 2017-04-06 14:22

In this case study on docslikecode.com, Jennifer Rondeau shares her story of gaining the trust of her developer coworkers so that she could edit code comments for a remote management web service at Symantec. This is an excellent, in-depth piece, and I really appreciate her writing it up to share.

While Jennifer was writing up the story on GitHub and I was reviewing the case study, I asked her to clarify a couple of points she made about fully integrating with the development team. One was “Doc management was continually concerned that putting a writer into the code — writing code comments and code samples — would set developer expectations of the writers too high.” Ouch. She goes on to say that their root concern was about the extensibility of the model – they didn’t think it could scale across teams. While reviewing, she clarified to say that management didn’t want devs to think they could offload work that they ultimately were responsible for themselves, maintaining good code comments. Also, management found that the tech writers had much more code-savvy than originally thought, and the empathy and advocacy that writers could provide was well worth the risk in the embedded model.

Another point to clarify while drafting the case study was about doc build automation. In the end, they decided not to automate the doc builds as part of the code builds. I wanted to know: Was it a dev resources problem where doc builds were not prioritized high enough as compared to work on the services? Or, management didn’t want to invest the time? Or the writer didn’t find a way to do it herself? Or maybe the automation time savings wasn’t quite big enough for attention? She said, “Ultimately, the decision not to automate the Javadoc made sense — there are always pain points on either side of a decision like this.”

You can hear more from Jennifer in “Docs as Code: The Missing Manual,” co-presented with Margaret Eker at Write the Docs Europe 2016.

Categories: DITA

Gilbane Advisor 3-28-17 – customer experience, millenials, ad agencies, software complexity

Next-generation customer experience How do you link customer experience operationally and improve CX beyond individual touchpoints to succeed throughout the customer journey? Read More   Three millennial tech myths busted Ben Bajarin shares findings from a recent study of mostly 18-24 year olds. Many of you are likely to be surprised by at least one of the “busted […]

This post originally published on https://gilbane.com

Categories: DITA

Wikidata's excellent sample SPARQL queries

bobdc.blog - Sun, 2017-03-26 16:40
Learning about the data, its structure, and more. Bob DuCharme http://www.snee.com/bobdc.blog
Categories: DITA

Choosing an XML Model

Really Strategies - Fri, 2017-03-24 14:17
JATS FAQs.png

After seeing my infographic above, one of my colleagues asked me why I am so passionate about JATS (Journal Article Tag Suite NISO Z39.96) and its sister tag suite, BITS.  There are two big reasons: first, their suitability for the task, and second, the dedicated team of experts that designed them and continue to develop them.  That doesn’t mean I’m not an advocate for other tag suites.  I am, so long as they serve my passion about XML and using the right vocabulary for the job at hand.

Categories: DITA

How Pantheon Moved their Docs to GitHub

JustWriteClick - Fri, 2017-03-24 12:19

Check out this great case study by Rachel Whitton, Technical Content Editor at Pantheon. Their product is a website management platform for WordPress and Drupal and the case study is available on docslikecode.com.

I love how eager and willing Rachel is to share her story with other practitioners who are wrangling content with these tools and techniques. She was Pull Request number 1 in the new GitHub repo where I’m gathering stories about treating docs like code. Super grateful for her story.

She presented “Delivering High-Velocity Docs that Keep Pace with Rapid Release Cycles” at Write the Docs Europe in October 2016. Well worth watching when you’re looking for both innovation and inspiration.

Categories: DITA

Gilbane Advisor 3-14-17 — voice, wearable machine learning, chinese CX, blockchain

CX and the age of the appacus This Economist article about fintech in China is important not just for economists or financial technologists, but for customer experience professionals. China is “far and away the biggest market for digital payments, accounting for nearly half of the global total”. Beyond digital payments, there is Chinese fintech support […]

This post originally published on https://gilbane.com

Categories: DITA

RSuite Adds Integrated Edit and Publish Modules to its Enterprise Information Management Solution

Really Strategies - Tue, 2017-03-14 11:49

Audubon, Pa.— March 14, 2017— RSI Content Solutions, creators of the RSuite Enterprise Information Management Solution, today announced the release of two new fully-integrated modules, RSuite Edit and RSuite Publish.  Together, these applications enable RSuite customers to further enhance their ability to manage and produce print and digital content in a single enterprise-strength solution.

RSuite Edit provides a simple, user-friendly interface that allows RSuite users to seamlessly create and modify content directly within the publishing solution.  Authors, contributors, editors, and reviewers can produce structured content in an intuitive, browser-based environment.

RSuite Publish provides an automated, template-driven capability to produce print and digital outputs, rather than having to rely on manual design processes.  Publishers can automate the creation of both print-ready PDF and EPUB output with a simple click of a button.

“RSuite enables many organizations to cut the time between authoring and delivery in half,” stated Lisa Bos, CTO/EVP Publishing Solutions at RSI Content Solutions.  “With RSuite, they deliver more and more consistent content through streamlined processes and automation. RSuite Edit and RSuite Publish make it even easier to include more users throughout the enterprise in publishing workflows, without needing special technical expertise."

About RSuite®

RSuite is the MarkLogic-based enterprise information management solution optimized for the creation, management, reuse and delivery of multi-format, multi-channel content. It combines the power of the MarkLogic platform with an enterprise?strength workflow engine, a fully-integrated authoring and editorial interface, and an automated composition engine to support both print and digital outputs.  For more information, please visit http://www.rsicms.com/rsuite-enterprise-publishing-solution.

About RSI Content Solutions

For over 16 years, RSI Content Solutions has been at the forefront of implementing content agility solutions for publishers, media companies, Fortune 1000 businesses, government organizations, and more.  With headquarters outside Philadelphia, PA, USA, an engineering center of excellence in Chennai, India, and affiliate offices around the world, RSI has helped over 250 global organizations implement appropriate content agility solutions. For more information, please visit www.rsicms.com.

Categories: DITA

RSuite at the 2017 London Book Fair

Really Strategies - Fri, 2017-03-10 12:01
LBF_2017_stand_alone_logo.png

Rob Smilowitz and I are once again gearing up for the annual London Book Fair next week, one of the best events of the year.  We’re in Stand 3B72 and will be giving demos of RSuite, complete with two brand new components we will be announcing the first day of the show!

Categories: DITA

Seven Habits of Highly Effective Technical Writers

The Content Wrangler - Tue, 2017-03-07 09:18

A passion for learning is the most important qualification for an effective technical writer. You can become an ace technical writer by fine-tuning the way you learn. How you go about learning will make the difference between good results and great results.

Focus on increasing your mastery in:

  • Learning technology
  • Writing
  • Working with others

Regardless of the country in which you are working, you can use these Seven Habits of Highly Effective Technical Writers as a guide to mastering technical writing excellence.

1. Don’t Take It Personally (learn)

Great technical writers thrive on criticism. They understand that it enables them to improve and to improve the accuracy and readability of their content. So, don’t take criticism personally. Use it to your advantage.

Sai Salgado, Graphic Designer, Saiff Solutions

2. Learn Before Asking (respect, impress)

Learn as much as you can from available resources before asking questions. In this way, you can respect others’ time and impress your colleagues with your ability to ask intelligent questions.

Sai Salgado, Graphic Designer, Saiff Solutions

3. Ask (often)

Technical writing requires good people skills. Don’t attempt it alone. Ask questions. Ask for help.

Sai Salgado, Graphic Designer, Saiff Solutions

4. Rewrite (always)

Pick 3 of your favorite writers. If you were able to see their first drafts, you’d probably think, “I can do much better.” The best writers in the world are the best re-writers. Always rewrite, rewrite, and rewrite some more.

Sai Salgado, Graphic Designer, Saiff Solutions

5. Acquire Feedback (test, reviews)

Technical writing is almost never 100% in the first draft. Without adequate testing and review, accuracy is often unattainable. Make sure you get the feedback you need to excel.

Sai Salgado, Graphic Designer, Saiff Solutions

6. Understand (before publishing)

When you start, you may not fully understand your subject matter. That’s fine. By the time you publish, make sure you do understand. If you don’t understand what you write, your readers are not likely to understand it, either.

If you write something, you need to understand what you wrote. Even if it is just a draft to show your editor, you need to either a) fully understand what you wrote, or b) have a list of questions. Do not write a sentence that you do not understand.

Sai Salgado, Graphic Designer, Saiff Solutions

7. Contribute

Notice things. Does the prototype work as expected? Are the user interface labels capitalized consistently? Ask questions. Make suggestions. Be a part of the product team.

Sai Salgado, Graphic Designer, Saiff Solutions

Source (republished with permission)

Barry Saiff is a leading expert in technical writing outsourcing and managing technical writers. For more than 32 years, Barry has experienced technical writing outsourcing from both sides—as a technical communications leader in the USA, and as a manager of offshore technical writers and customer liaison in the Philippines. Barry frequently leads webinars and speaks at conferences. His popular 7 Habits series of blogs, infographics, and webinars has been featured by the Society for Technical Communication. He has consulted for a variety of companies to help them improve their content and content development processes. Barry is featured in the Content Wrangler webinar Managing Technical Writing Outsourcing in an Agile Environment. Find out more here. Learn more about Barry’s company, check out Saiff Solutions.

The post Seven Habits of Highly Effective Technical Writers appeared first on The Content Wrangler.

Categories: DITA

Digital Transformation: Information Development World

The Content Wrangler - Tue, 2017-02-28 20:32

Information Development World 2017

Back by popular demand! The Content Wrangler and Content Rules will host Information Development World (IDW) this May 15-17, 2017 at the Quadrus Conference Center in Menlo Park, CA.

Early bird pricing is in effect until March 31, 2017. Save $300USD when you register before then.

IDW is an annual, intimate, three-day, laser-focused content conference designed to prepare you for the coming artificial intelligence revolution. We bring together — in the heart of Silicon Valley venture-capital land—an impressive roster of knowledgable content professionals—innovators, artists, scientists, engineers, academics, and business leaders—in one big room and take you step-by-step through the topics that matter.

Your guided journey begins with a focus on the business activities, processes, competencies, and tools required to take full advantage of opportunities digital technologies provide us today and in the future. Each day has a particular focus and is divided into four bite-sized chunks, making it easy for you to have a-ha moments and identify next steps you’ll need to improve to prepare your content for the future.

May 15, 2017—Digital Transformation

Presentations will cover:

  • Changing the way we work
  • Leveraging design thinking for content
  • Mapping content to the customer journey
  • Creating engaging and memorable content

May 16, 2017—Thinking Strategically

Presentations will cover:

  • Developing a content strategy
  • Creating value for company and customers
  • Connecting content to those who need it
  • Implementing and maintaining governance

May 17, 2017—Innovation and Disruption

Presentations will cover:

  • Overcoming the status quo
  • Leveraging machine learning
  • Understanding artificial intelligence
  • Making content cognitive

Who should attend?

IDW is designed to serve the needs the people who plan, create, design, manage, translate, prepare, and deliver content to the prospects, customers, systems, devices and other machines that need it.

The conference will be particularly valuable for those whose job it is to create exceptional customer experiences with content.

I hope you’ll take a peek at our amazing roster of presenters and plan to attend Information Development World this May. It’s going to be an amazing event.

Questions? Just ask.

The post Digital Transformation: Information Development World appeared first on The Content Wrangler.

Categories: DITA
XML.org Focus Areas: BPEL | DITA | ebXML | IDtrust | OpenDocument | SAML | UBL | UDDI
OASIS sites: OASIS | Cover Pages | XML.org | AMQP | CGM Open | eGov | Emergency | IDtrust | LegalXML | Open CSA | OSLC | WS-I