Monthly Archives - November 2013

28 Nov

Top 5 Reasons Why Should You Invest in a Content Vendor?

Top 5 Reasons Why Should You Invest in a Content Vendor?

Image showing a box containing the names of content outputs and work products.In the present business scenario, there are quite a few companies who have a content team or technical publications department in place. They are the ones who understand the value of having content creation or documentation expertise in-house. There are other companies who either don’t have the budget or a permanent need to employ a team of writers and obviously some managers to look after them. Most of such companies rely on freelancers or contractors when they have a content requirement such as refurbishing their website or blog, and may be when a product needs documentation just before shipping it out. Many people would agree that there are challenges in working with freelancers. Here are top five reasons why organizations should seriously consider investing in a specialist content vendor or content service provider.

1. Using A Specialist On The Job Is Always Better

It is always safer to have a specialist do the job. Though it seems anyone with good language skills can produce any kind of content but let’s admit that it is just a myth. Even within the range of content, there is whole lot of variety to be dealt with and there are specialists in handling technical content, business content, web content or something for print media.

Besides, there are some search engine (read google) trends to be followed at a given time, differences in writing styles across geographies and industries. An experienced writing professional would be able to add greater value from all the significant perspectives.

2. An Established Content Services Provider Is More Reliable Than A Freelancer

If a content vendor is a registered company then its reliability quotient is much higher than a freelancer sitting in a remote place, a few continents away. While it is possible for a freelancer to vanish and return with a brand-new profile and persona, it is not so easy for a company that has to create a name for itself and grow its business in the long term.

A content vendor would be more likely to have a business continuity plan and adequate resources to deliver in time even in case of materialization of some risks.

 3. A Content Vendor Can Give More Variety Than A Freelancer

A content service provider would be able to provide a great deal of variety in content solutions ranging from website content, blogs, brochures, case studies to user manuals, online help and training videos or e-learning solutions. A team of independent contractors or freelancers may be able to produce all of this but it would be a herculean task to coordinate and get consistent results in quality as well as timelines.

4. A Content Vendor Assumes More Accountability And Shares The Risks

Some organizations, owing to their domain and industry segment, might often be under the threat of facing legal consequences due to copyright or plagiarism issues. It is imperative to review their content for originality before it is published or circulated. Service-level agreements are one of the means of ensuring that the authors take some responsibility but a vendor company is far better risk-sharing partner than an individual. Besides, a content vendor may employ better means to check plagiarism such as a peer-review process or using plagiarism detection tools.

5. A Content Vendor Saves Management And Quality Assurance Costs On Content Production

Managing a team of freelancers also has a cost. More than the cost factor, it is the ability to judge the quality, originality and cost of content production that needs a relatively much experienced professional with content or documentation expertise.  A freelance writer is self-managed but a team of contractors would need a manager. A content services provider, on the contrary, would be able to provide an expert supervision and project management at a comparable much lower cost than a full-time manager to manage a need-based engagement with freelancers.

By Content Writing, e-learning, Instructional Designing, Technical Writing , , , , 0 Comments
Read more...
22 Nov

Documentation Development in Agile Development Models

Documentation Development in Agile Development Models

In the previous post, we discussed about the integration of Documentation Development Life Cycle (DDLC) with the Waterfall Model of Systems Development. Now that the software engineering is evolving to bring in more speed, efficiency, and tendency to provide quicker insights into the final outcomes, there are newer methodologies gaining popularity. Agile Development is one such approach that talks about having increments of working software developed in some defined time periods to give more clarity and garner confidence of developers and customers alike.

With the change in perspective, documentation development needs to change suit too. Let’s see how does the technical and user documentation get affected while progressing in an Agile fashion. To understand the change solicited by the Agile Development process, let us understand what it demands.

There are many Agile Development models such as Scrum, Extreme Programming, Agile Modeling and so on. For this post, I would consider Scrum model to explain Agile Development process.

The essence of Agile Development lies in more emphasis on collaboration, communication, incremental tangible outcomes, and active customer participation. However, it doesn’t completely ignore the importance and role of processes, documentation, and extensive planning. It puts more focus on what needs to be built rather than aggressively tracking how it is being built. Agile Development is all about being receptive to change and adapting quickly. It also puts more responsibility on team members to communicate, collaborate, give ideas, identify risks, propose solutions, set goals, prioritize tasks, and track the status for one’s work products.Image depicting the stages in an Agile Software Development model

To be precise, the Agile Development models split the main project objective or goal into small and smaller increments that would be developed over a number of time frames such as a week to a month, during the estimated project duration. For every defined cycle, also called a Sprint, each member has to identify his work product or software increment that is complete in a way and can be used.The tasks are identified in a very interesting manner by depicting them as “user stories” wherein a user should be able to use the work product to accomplish something.

Communication and collaboration take the center stage. The team meets before the start of every sprint to plan for it and then once again after they finish the sprint—to review the progress, challenges, risks, identify the lessons learned and the best practices for future. But that’s not all they have for communication and collaboration. They meet on a daily basis in a very short meeting that gives a chance to share about the progress, bottlenecks, and to plan when and where they can get help.

Transparency is the main keyword. All Agile Developments models ensure that all the team members know what the other person is doing. It helps in proper coordination and better planning.

So, the take away for the documentation engineers is:

The technical writers can see the bigger picture right through the beginning as they are included in the sprint planning meetings.

The technical writers get to interact with all team members or any specific member, who could help with the required information. This eases the requirement understanding and requirement gathering challenges.

At every change initiation, they get a chance to discuss the impact on documentation and plan for it in time.

The most important aspect for technical writers is time management and planning the activities that aren’t dependent on work product in any sprint. Some examples of such activities could be preparing templates or stylesheets, and so on. They have to ensure that they schedule such activities either in early sprints where there is more of analysis and design underway or whenever they finish their work product sooner in a sprint.

As for the Documentation Development Life Cycle (DDLC), it shrinks to fit in every single sprint and follows an iterative and incremental approach.

Overall, working in an Agile Development model gives more comfort, support, and visibility to the technical writers and they don’t seem to work out of an island.

By Documentation Development Life Cycle, Documentation Process, Documentation Project Management, Project Management, Technical Writing , , , , , , , , 0 Comments
Read more...
14 Nov

Mapping Documentation Development Life Cycle (DDLC) with SDLC

Software Development Life Cycle is a sequence of phases or logical stages in the course of development of an idea into a software application or a product. It is commonly abbreviated as SDLC. A well-known traditional approach to SDLC is known as Waterfall Model. The Waterfall Model lists the stages in the life cycle as:The_Waterfall_Model_software_engineering_ascezen

  1. Communication (Project Initiation, Requirements Gathering)
  2. Planning (Estimating, Scheduling, Tracking)
  3. Modeling (Analysis, Design)
  4. Construction (Code, Test)
  5. Deployment (Delivery, Support)

For any software application to be developed, the development team isn’t just constituted of software engineers, analysts, and architects. It also requires people to test and document the processes as well as the product. The group that works on creating and maintaining documentation is known as Documentation or Technical Publications group and it is composed of Technical Writers—people who can create Technical and User Documentation.

The Technical Writers also follow a development cycle for creating documentation, which is known as Documentation Development Life Cycle. The Documentation Development Life Cycle (DDLC) maps with the SDLC such that the entire product team works in close coordination to complete the development, adhering to a common project schedule. Modeled on SDLC, the DDLC has somewhat similar stages as that of SDLC. However, the duration of stages varies according to the difference in availability schedule of inputs for various stages. Let us begin with taking a look at the stages in the DDLC.

The DDLC stages, as understood by Technical Writing team at Ascezen, include the Image depicting stages of Documentation Development Life Cycle (DDLC)following:

  1. Understand Requirements
  2. Design
  3. Develop
  4. Review
  5. Finalize
  6. Publish

The activities to be performed during each of the stages are listed below:

  1. Understand Requirements
    • Understand the Product or Application to be developed
    • Gain an understanding of the Domain or Subject Matter
    • Understand Client Requirements for Documentation
    • Study Legacy Documentation and Writing Style Guides used by the Client
    • Provide Content Consulting or Evangelism
    • Propose Documentation Deliverables and Tools to be used
    • Prepare Effort Estimate
    • Propose Team Size and Composition
  2.  Design
    • Prepare Templates and Stylesheets
    • Prepare an Outline or the Table of Contents for documents to be created
    • Create Content Strategy for Single-sourcing or writing for multiple user roles
    • Create a Documentation Project Schedule
  3. Develop
    • Gather Information: Read Design Specifications ,Interview Subject Matter Experts (SMEs)
    • Create Content Drafts
    • Create and Insert Graphics
    • Format the Content
    • Generate Output(s)
  4. Review
    • Language Review
    • SME or Technical Review
    • Client POC’s Review
  5. Finalize
    • Incorporate agreed changes after each review
    • Finalize the Content
  6. Publish
    • Integrate the Documentation with the Product or Application
    • Send for final publishing or distribution

Mapping Documentation Development Life Cycle with SDLC

Mapping the Documentation Development Life Cycle (DDLC) with the Software Development Life Cycle (SDLC) isn’t as straightforward as it seems. Some of the reasons are:

  1. Documentation starts quite late in the SDLC: Most often, the last few to get on board a project are the documentation people. Even if they aren’t, the requirement understanding stage for technical writers is extended till the time they get to read a formal requirement specification document or see a prototype. However, it doesn’t happen like that always as sometimes technical writers get to document the design specifications too.
    Image depicting the mapping of stages in SDLC and DDLC
  2. Documentation can’t finish as soon as the Software Development: It is only when the entire software application is developed that the documentation can be given its final shape. Even after all the content in created, there are activities such as language and SME reviews, creating index entries, generating and testing final outputs. All this may take some time until we can announce the completion.
  3. Trivial Changes in the Application may call for Critical Documentation Updates: Small changes such as change in UI resulting in relocation of a button or field, modification in input type on a form, reorganization or reordering on menu may account for an unexpected volume of change across the documentation. It might also require recapturing and replacing numerous screenshots.

With the above factors, the DDLC may not have all its stages completely go hand-in-hand with the SDLC stages. The Requirement Understanding stage of DDLC goes on till the commencement of Construction or Development phase of SDLC. Typically, there would be a lag in Documentation Finish dates and the DDLC would extend the duration of SDLC, too.

By Documentation Development Life Cycle, Documentation Process, Technical Writing , , , , , , , , , , , , , 0 Comments
Read more...
05 Nov

The Potential of Minimalism in Content and Website Design

If you want to develop a mobile version of any website, it will be a good idea to go with a minimalist approach. Quite a few critics cringe at the notion of minimalist design, presuming it will make the overall design and layout boring. The concept is also misinterpreted as black text on a white background devoid of any effects or graphics. However, all these assumptions are very far from the reality. It must be noted that minimalism does not involve dull or uninteresting techniques or features. The main objective of minimalism is to present different elements and features in their primary role, without the need to involve unnecessary frills and distractions. In reality, several usability experts have a view that minimalism will enhance the impact and effectiveness of website designs.

Some Advantages of Minimalism

  • Most usability experts believe that minimalism will definitely rule the roost in the future. The concept offers several interesting and unique ways to simplify uncomplicated website designs without much effort. Minimalism will enable users to use their smartphones and internet to access most of the web applications without any technical glitches emanating from compatibility issues.
  • The main functionality of minimalism is to restrict the intended message to its bottom line so as to provide clarity of ideas and expressions. Users may begin to complain as little as possible after being exposed to the powerful results of minimalism.
  • The concept will certainly find favor with mobile web users. It will enable users to download the content faster.
  • Users will be able to access the content in different layouts on different platforms with superior quality and increased smoothness.
  • Smartphone users browse internet on their phones quite frequently and they might easily get irritated if they have to needlessly navigate to many web pages or unrelated information before they get what they are looking for. A minimalist website design can easily eliminate inappropriate clutter of information or webpages.
  • Minimalism helps in brand building too. It is very important for a brand to stay consistent in order to be remembered for being neat in expressions. By removing clutter that is considered to be perplexing, a brand can definitely stand out in the crowd.

Mobile manufacturing companies can get benefited with the assistance from usability professionals to adopt minimalism in design. Today, mobile devices and components come with smaller bandwidth, slower data internet connectivity and smaller screens. All these technical restrictions can be effortlessly overcome by a unique minimalist design. The technology will unquestionably enhance mobile website designs and other technicalities in the future.

Minimalism in Writing

“The more you say, the less people remember. The fewer the words, the greater the profit.”
– Francois Fenelon

Most popular writers, authors, and poets have believed that brevity is very important to engage one’s audience. There, all we want to say must be said in brief. Let’s find out how some of us tend to get lengthier. Some writers create content using 2nd person singular tone. It is considered very friendly. Certainly, it results in passive voice, which tends to detach the reader from the action because the sentences become lengthy and boring. This type of writing might confuse the readers as well. Therefore, it is better to create understandable active voice constructions to appeal the readers’ minds.

The current norm is minimalist writing. This type of writing is considered to be straightforward without being lengthy and uninteresting. The overall idea is to include appropriate information needed for the readers – no more, no less. The writer should create the content in a comprehensible, direct active voice.

Minimalism Unchained   

Some people have an opinion that minimalist writing includes very few words or sentences. But in reality, minimalist writing is not easy. You need to explain the entire information or concept involving very words or phrases. The idea is to use less words and sentences but they must have a bigger impact on the mind of the readers. You need to question any phrase or word that you are about to use to know whether it is essential to communicate your intended message. You might need to think, review and rewrite to be sure of being brief and complete in communicating.

Some Tips for Minimalist Writing

  • Keep sentences brief and straightforward.
  • Infuse coherence in successive sentences to keep the flow.
  • Consolidate the cluster of short sentences in meaningful paragraphs.
  • Do not discuss several topics in a single paragraph to avoid confusing the reader.
  • Ensure that paragraph length is appropriate.
  • Always prefer active voice.
  • Use images or pictures to convey a powerful message instead of explaining it endlessly.

translate from french to english

By Content Writing, Creative Writing, Minimalism, Technical Communication, Technical Writing , , , , , , 0 Comments
Read more...