Wednesday, April 8, 2015

Telecommunication

An overview

We all know that telecommunications has evolved tremendously from telegraphs to the telephones and the current smart phones. This evolution not only involved the user equipment, but also the technology.

The technologies used for telecommunications have changed greatly over the last 50 years. Empowered by research into semiconductors and digital electronics in the telecommunications industry, analog representations of voice, images, and video have been replaced by digital representations. The major consequence has been that all types of media can be represented in the same basic form (i.e., as a stream of bits) and therefore handled uniformly within a common infrastructure (most commonly as Internet Protocol or IP, data streams). Subsequently, circuit switching was supplemented by, and will likely ultimately be replaced by, packet switching.

The most fundamental change, both in terms of technology and its implications for industry structure, has occurred in the architecture of telecommunications networks.

How are the networks different?

First, they are integrated. All media, be it voice, audio, video, or data are increasingly communicated over a single common network. This integration offers economies of scope and scale in both capital expenditures and operational costs. In addition, it also allows different media to be mixed within common applications. As a result, both technology suppliers and service providers are increasingly in the business of providing telecommunications in all media simultaneously rather than specializing in a particular type such as voice, video, or data.

Second, the networks are built in layers. Starting from the physical layer, which is concerned with the mechanical, electrical and optical, and functional and procedural means for managing network connections to the data, network, and transport layers, which are concerned with transferring data, routing data across networks between addresses, and ensuring end-to-end connections and reliability of data transfer to the application layer, which is concerned with providing a particular functionality using the network and with the interface to the user.

Evolution

The paradigm has changed since the early analog mobile generation (1G) to the last implemented fifth generation (5G). The new mobile generations do not pretend to improve the voice communication experience but try to give the user access to a new global communication reality, via data packets. The aim is to reach communication ubiquity and to provide users with a new set of services.

The first operational cellular communication system was deployed in Norway. These first generation (1G) systems provided voice transmissions by using frequencies around 900 MHz and analog modulation.

The second generation (2G) of the wireless mobile network was based on low-band digital data signaling. The most popular 2G wireless technology is known as Global Systems for Mobile Communications (GSM). The first GSM systems used a 25 MHz frequency spectrum in the 900 MHz band. The two schemes Frequency Division Multiple Access (FDMA) and Time Division Multiple Access (TDMA) schemes were used to allow simultaneous calls on the same frequency.

While GSM was developed in Europe, Code Division Multiple Access (CDMA) was developed by Qualcomm in North America. CDMA uses spread spectrum technology to break up speech into small, digitized segments and encodes them to identify each call. The technology distinguishes between multiple transmissions carried simultaneously on a single wireless signal.

The 2G technologies mentioned above, are based on circuit-switch technology and can handle data rates of upto 9.6 kbps and hence not suitable for web browsing and multimedia applications.

This led to a new technology - General Packet Radio Service (GPRS) which was known as 2.5G. GPRS provides both a means to aggregate radio channels for higher data bandwidth (up to 60 kbps) and the additional servers required to off-load packet traffic from the existing GSM technology.

In the world of 2G, voice takes precedence over data which is already dominant in the wireline communications. So, there was a need to overcome the painfully slow data connections and enahance the speed. The idea behind developing the 3G technology was to prepare a universal infrastructure able to carry existing and also future services and provide better quality data service to the user, thus generating more revenue to the operators.

Features

The advantages of 3G over the previous networks are enormous:

  • High data rates – up to 2 Mbps
  • Security – by allowing the UE to authenticate the network it is connecting to; user can be sure that this is the intended network
  • Several times higher data speed – downlink/uplink – up to 2 Mbps
  • Enhanced audio and video streaming
  • Video-conferencing support
  • Web and WAP browsing at higher speeds
  • IPTV support

Due to the requirement of a new technology and bandwidth, 3G wireless needed to be built on a new infrastructure. See figure below for the 3G (W-CDMA) architecture).

With the advent of mobile internet access, suddenly the circuit-based backhaul network from the base station and back had to significantly change. 3G systems are IP-centric and will justify an all-IP infrastructure.

Issues foreseen

When it became clear that the real killer application was the internet, it was obvious that users would want data access on-the-go. A huge capital is required to build the 3G infrastructure. So, this is a huge setup to transport the speech signals over the given channel width.

The significant issues foreseen with the 3G setup and users' demand for internet on-the-go are:

  • High spectrum licensing fees for the spectrum
  • Huge capital required to build infrastructure for services
  • High prices for mobile services

Conclusion

There will be no flip to this technology, but only evolution. 3G services will add invaluable dimension for the integral part of the modern world. In the near future, 3G services will not be considered as a value-add, but a fundamental aspect.

References: Wiley's and internet

Thursday, September 20, 2012

Editing


What is editing?

Editing is improving the quality of the content produced by an author or individual by adhering to the following:

  • Clear
  • Consice
  • Correct
  • Complete
  • Consistent

Why is editing required?

Writers are humans and can miss the "obvious" spellings and other rules. The editors may detect the missed errors, thus ensuring conformance to the standards.

Writers, peers or designated editors can edit the content of a document.

The aspects of editing

The following aspects can be considered:

  1. Language - which includes spelling, grammar, punctuation, parallelism and symbols, word usage and terminology
  2. Organization - Trademark acknowledgements, legal and safety statements, regulations, standards and style guidelines and integrity (title, headers and footers)
  3. Reader - Safety and usability, readability and navigation, structure of information, and ambuguity
  4. Author - Respect for the content and schedule (to avoid last minute updates), sensitivity in providing the comments

Thursday, April 12, 2012

Documentation Development Life Cycle

Documentation Development Life Cycle aka DDLC describes the cycle from the pre-engagement meeting with a client until the document delivery.

Just like every software product is developed adhering to the Software Development Life Cycle (SDLC),

The stages in DDLC are:

  1. Analysis
  2. Design
  3. Develop
  4. Evaluate
  5. Deliver

Analysis

In this phase, the documentation needs, tools required, resources etc. are analyzed. The project plan is submitted to the client for review and approval.

Deliverables

  • Project plan
  • Progress report

Design

In this stage, the requirements from stage 1 (Analysis) are established. A detailed outline is developed. An estimate is made on the total number of pages in the document. Template and prototype are also developed in this stage. When all the above are set in place, revise and review the project plan.

Deliverables

  • Detailed outline
  • Project plan revisions
  • Progress reports

Development

In this stage, the number of hours required to develop the document is defined. The prototype is approved by the client. If there are any graphics, design or develop them. Drafts are sent for review. Finally, revise and edit drafts and obtain client approval for all the documents developed at this stage.

Deliverables

  • Prototype
  • Style guide
  • Drafts
  • Progress reports

Evaluation

In this stage, appendices, glossary, etc. are created and a final edit is performed. Document is sent for final approval and the ToC's are created. Finally, client approval and sign-off is obtained.

Deliverables

  • Final drafts with graphics
  • Progress reports

Delivery/Release

The documents are released to the customer in appropriate format. The maintenance or updates (version updates) required is determined in this stage.

Deliverables

  • Document

Wednesday, March 14, 2012

Version control

What is version control?

Version control aka revision control or source control is an aspect of software and documentation configuration management; it is the change management to documents, programs, large web sites and other information stored as computer files. It is most commonly used in software development, where a team of people may change the same files. Changes are usually identified by a number or letter code, termed the revision number, or revision level. Version control is a software to keep track of all the revisions and releases pertaining to a product.

For instance, an initial set of files is revision 1. When the first change is made, the resulting set is revision 1.1 or 2, and so on.

Each revision is associated with a timestamp and the name of the person making the change.

There are many configuration systems available in the market today. Listed below are some of the advantages of having a document CMS.

Advantages of having a documentation configuration management system

  • Tracking of all revisions and releases of project’s files can be easily managed
  • Archive of changes is well maintained
  • Any level of previous changes can be retrieved
  • Collabarative – ie allows to make concurrent changes to a file

Tuesday, March 13, 2012

Process

In general, process can be defined as a sequence of interdependent and/or dependent procedures, which at every stage, consume one or more resources (employee, time, money, etc.) to convert input into output. These output can be served as input to the next stage until the goals are achieved.

In simpler terms, process is a series of actions, changes or functions that bring about a known result or goal.

The process established in each company varies, depending on the requirements and available resources. But, in general the technical publications has a process set up, which must be adhered to by the team. The process overview diagram is shown below.

Friday, February 17, 2012

Technical Writing

Technical Writing: Types of technical documents

 

In engineering,technical documentation refers to any kind of document that describes the functionality and architecture of any product under development or testing. Types of documentation include the following:

  • User manuals
  • Release notes
  • Application note
  • Data sheets
  • Online help
  • Troubleshooting manuals
  • Feature Activation Guides

User manuals

User manuals, commonly known as user guides are manuals that explain in detail about a particular product or a system. These manuals are written by a writer and are commonly associated with images which include screen shots, clear or simplified images.

Contents of a User manual

The sections in a user manual or guide commonly include the following:

  1. Cover page - title and copyright
  2. Preface - which contains details of reference documents and information on how to navigate the guide
  3. Contents page
  4. Product overview - which gives details about the product
  5. Troubleshooting section detailing possible errors that may occur, along with the problem solving steps on how to resolve the errors
  6. FAQ's
  7. Glossary

Release notes

Release notes are documents that are distributed along with the product that is either in the development or testing phase. For products that are already in use by the clients, the release notes is a supplementary document that is delivered to the customer when there is a bug fix or an enhancement in the current release.

Contents of release notes

The sections in a release notes commonly include the following:

  1. Cover page - title and copyright
  2. Preface
  3. Contents page
  4. Overview - which includes the following:
    • Purpose
    • Audience
    • Scope
    • Assumptions
  5. System requirements - which includes the following:
    • Hardware
    • Software
    • Patch baseline
  6. Fixed bugs
  7. Known bugs
  8. Limitations and Enhancements

For most companies, release notes are written by the development teams. It is not easy for a technical writer to do this, for the fact that the writer should know the product very well and also be involved in the testing phase (having access to the bug reporting tool), know the packages to be delivered and additional useful information to be mentioned in the release. These information are gathered during end-to-end product implementation. When the writer is involved in the process of software release management,it becomes easier to create a release document.

Application note

An application note is a document that gives specific details on using a component in an application; for instance, the physical assembly of a product containing the component. Application notes are either appended to a data sheet or are released as a stand-alone document.

Data sheets

A data sheet summarizes the performance and other technical characteristics of a product, component (usually electronic in nature) or a software in sufficient detail to be used by a design engineer to integrate the component into a system.

Online help

Online help is a procedural, topic-oriented information that is delivered through a software. Most online help is designed to assist the user in the use of a software application or OS, but it can also be used to present information on a broad range of subjects.

Troubleshooting manuals

Troubleshooting is a form of problem-solving that is applied to something that has suddenly stopped working since its previous working state. It requires identification of the malfunction(s) or symptoms within a system. Then, experience is commonly used to generate possible causes of the symptoms. Determining which cause is most likely is often a process of elimination - eliminating potential causes of a problem.

Finally, troubleshooting requires confirmation that the solution restores the product or process to its working state.

The steps involved in this process are collectively put into the document. Such a document is called a troubleshooting manual.

Feature Activation Guides

A feature activation guide, is a document that defines the new feature introduced in the release and also details the procedure or process involved in activating that feature.

This may require the writer to have access and exposure to some of the test environment/network.

What is technical writing?


Technical writing is probably the most widely read form of written communication around, with the exception of advertising. It is a craft that aims to provide technical, business or educational information in a clear and concise manner. 


Technical writing in business can include training manuals, employee guidelines or handbooks and other specialized writing that is task specific.


Technical writing is arguably more difficult than other forms of writing because of the fact that it must be clear and to the point. Good technical writing should not leave any room for imagination and it must anticipate and answer any questions or problems that may arise. This aspect of technical writing is often seen in ‘frequently asked questions’ and ‘trouble shooting’.


The demand for technical writers is high, which makes a career in technical writing a great option for many writers or others who have great organizational, grammar and communication skills. Technical writing provides a decent salary and is often available to freelancers as well as onsite employees. There are many training programs available for people who wish to enter the field of technical writing.